Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Copy this file to .env (in the repository root) and fill in the values.
# Never commit .env: it is in .gitignore.

# Required outside debug mode. Generate one with:
# python -c "from django.core.management.utils import get_random_secret_key as k; print(k())"
DJANGO_SECRET_KEY=

# Set to True only on your own computer, never on a server.
DJANGO_DEBUG=False

# Comma-separated host names the site is served from.
DJANGO_ALLOWED_HOSTS=127.0.0.1,localhost,.eu.pythonanywhere.com
# Full origins (with https://) allowed to send forms, for HTTPS deployments.
DJANGO_CSRF_TRUSTED_ORIGINS=

# Optional
# DJANGO_LOG_LEVEL=INFO
# DJANGO_SECURE_SSL_REDIRECT=True
# DJANGO_SECURE_HSTS_SECONDS=31536000
# DJANGO_ANON_THROTTLE=30/minute
# DJANGO_MEDIA_ROOT=/path/to/uploads

# PostgreSQL (leave POSTGRES_DB empty to use SQLite)
# POSTGRES_DB=
# POSTGRES_USER=
# POSTGRES_PASSWORD=
# POSTGRES_HOST=127.0.0.1
# POSTGRES_PORT=5432
2 changes: 2 additions & 0 deletions .github/workflows/django.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ jobs:
pip install pytest-django
- name: Run tests
working-directory: ./mysite
env:
DJANGO_SECRET_KEY: ci-only-not-secret
run: |
DJANGO_SETTINGS_MODULE=mysite.settings pytest dss/tests.py
python manage.py test api dpp
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ To install the application on your computer, open a command line and run:
pip install sce@git+https://github.com/CMLPlatform/SCE_API.git
```

# Configuration
Settings that differ per computer or server (secret key, debug mode, host names, database) are read from environment variables or from a `.env` file in the repository root. Copy `.env.example` to `.env` and fill it in. For local development, setting `DJANGO_DEBUG=True` is enough; on a server, always set `DJANGO_SECRET_KEY` and keep `DJANGO_DEBUG=False`.

## Access rules
- The web interface requires login, except the welcome page and published DPPs (`/dpp/final/<uuid>/`).
- Production lines, and their processes, exchanges, transport entries and publishing steps, are only visible to the user who created the production line (and to staff). Companies, materials, products and background processes are shared between all logged-in users.
- The REST API (`/api/`) requires login. Published DPPs (`/api/metadata/`) can be read by anyone; only staff can change them.
- The Decision Support System API (`/dss/`) does not require login, so other tools can call it, but anonymous calls are rate-limited. Sessions are identified by a random ID (UUID), returned as `session_id`.

# User Manual
## Key features
This software helps you to create Digital Product Passports in a streamlined way, to comply with the EU ESPR regulations. It is designed for manufacturers of consumer goods such as clothes, electronics, and batteries.
Expand Down
4 changes: 2 additions & 2 deletions mysite/api/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ class Meta:
model = Document
fields = ['file', 'type', 'issuer', 'instructions', 'language', 'issue_date', 'expiry_date', 'file_url']

def get_document_url(self):
def get_file_url(self, document: Document) -> str:
request = self.context.get('request')
file_url = self.file.url
file_url = document.file.url
return request.build_absolute_uri(file_url)

class ProductPropertiesSerializer(serializers.ModelSerializer):
Expand Down
13 changes: 12 additions & 1 deletion mysite/api/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
ManufacturingProcess, Facility, ProductExchange,
SustainabilityEvaluation, SustainabilityScore, ImpactCategory, ImpactIndicator,
)
from api.serializers import MetadataSerializer, ProductItemSerializer, ProductModelSerializer, SustainabilityEvaluationSerializer
from api.serializers import DocumentSerializer, MetadataSerializer, ProductItemSerializer, ProductModelSerializer, SustainabilityEvaluationSerializer


class MetadataSerializerTests(TestCase):
Expand Down Expand Up @@ -173,6 +173,17 @@ def test_file_urls_are_absolute(self):
self.assertTrue(first_doc["file_url"].startswith("http"))
self.assertIn(doc.file, first_doc["file_url"])

class DocumentSerializerTests(TestCase):
"""DocumentSerializer must return an absolute URL in file_url."""

def test_file_url_is_absolute(self):
doc = Document.objects.create(file="documents/LICENSE", type="manual")
doc.refresh_from_db() # Load as an API request does (issue_date as datetime).
request = APIRequestFactory().get("/api/document/")
data = DocumentSerializer(doc, context={"request": request}).data
self.assertEqual(data["file_url"], request.build_absolute_uri(doc.file.url))


class LifeCycleEventSerializerTests(TestCase):
"""
Tests for LifeCycleEventSerializer and its child classes
Expand Down
121 changes: 68 additions & 53 deletions mysite/api/urls.py
Original file line number Diff line number Diff line change
@@ -1,61 +1,76 @@
from django.contrib import admin
from django.urls import path, include
from . import views
from drf_spectacular.utils import extend_schema
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register(r'organization', views.OrganizationViewSet, basename='Organization')
router.register(r'institution', views.InstitutionViewSet, basename='Institution')
router.register(r'company', views.CompanyViewSet, basename='Company')
router.register(r'importer', views.ImporterViewSet, basename='Importer')
router.register(r'serviceoperator', views.ServiceOperatorViewSet, basename='ServiceOperator')
router.register(r'metadata', views.MetadataViewSet, basename='Metadata')
router.register(r'instruction', views.InstructionViewSet, basename='Instruction')
router.register(r'document', views.DocumentViewSet, basename='Document')
router.register(r'material', views.MaterialViewSet, basename='Material')
router.register(r'hazardousmaterial', views.HazardousMaterialViewSet, basename='HazardousMaterial')
router.register(r'productmodel', views.ProductModelViewSet, basename='ProductModel')
router.register(r'productbatch', views.ProductBatchViewSet, basename='ProductBatch')
router.register(r'productproperties', views.ProductPropertiesViewSet, basename='ProductProperties')
router.register(r'dppdetails', views.DppDetailsViewSet, basename='DppDetails')
router.register(r'secondaryproduct', views.SecondaryProductViewSet, basename='SecondaryProduct')
router.register(r'emission', views.EmissionViewSet, basename='Emission')
router.register(r'composition', views.CompositionViewSet, basename='Composition')
router.register(r'productitem', views.ProductItemViewSet, basename='ProductItem')
router.register(r'activity', views.ActivityViewSet, basename='Activity')
router.register(r'manufacturingprocess', views.ManufacturingProcessViewSet, basename='ManufacturingProcess')
router.register(r'productionline', views.ProductionLineViewSet, basename='ProductionLine')
router.register(r'process', views.ProcessViewSet, basename='Process')
router.register(r'backgroundprocess', views.BackgroundProcessViewSet, basename='BackgroundProcess')
router.register(r'productexchange', views.ProductExchangeViewSet, basename='ProductExchange')
router.register(r'envexchange', views.EnvExchangeViewSet, basename='EnvExchange')
router.register(r'alias', views.AliasViewSet, basename='Alias')
router.register(r'transport', views.TransportViewSet, basename='Transport')
router.register(r'lifecycleevent', views.LifeCycleEventViewSet, basename='LifeCycleEvent')
router.register(r'inspectionevent', views.InspectionEventViewSet, basename='InspectionEvent')
router.register(r'maintenanceevent', views.MaintenanceEventViewSet, basename='MaintenanceEvent')
router.register(r'itemexchange', views.ItemExchangeViewSet, basename='ItemExchange')
router.register(r'disassemblyevent', views.DisassemblyEventViewSet, basename='DisassemblyEvent')
router.register(r'indicatorset', views.IndicatorSetViewSet, basename='IndicatorSet')
router.register(r'impactcategory', views.ImpactCategoryViewSet, basename='ImpactCategory')
router.register(r'impactindicator', views.ImpactIndicatorViewSet, basename='ImpactIndicator')
router.register(r'sustainabilityevaluation', views.SustainabilityEvaluationViewSet, basename='SustainabilityEvaluation')
router.register(r'sustainabilityscore', views.SustainabilityScoreViewSet, basename='SustainabilityScore')
router.register(r'circularityevaluation', views.CircularityEvaluationViewSet, basename='CircularityEvaluation')
router.register(r'circularityindicator', views.CircularityIndicatorViewSet, basename='CircularityIndicator')
router.register(r'circularityscore', views.CircularityScoreViewSet, basename='CircularityScore')
router.register(r'circularityenabler', views.CircularityTrackerViewSet, basename='CircularityTracker')
from . import views

# Routes grouped by concern. Each group is one tag (section) in the
# OpenAPI docs at /schema/swagger/ and /schema/redoc/.
ROUTE_GROUPS = {
"Organizations": [
("organization", views.OrganizationViewSet, "Organization"),
("institution", views.InstitutionViewSet, "Institution"),
("company", views.CompanyViewSet, "Company"),
("importer", views.ImporterViewSet, "Importer"),
("serviceoperator", views.ServiceOperatorViewSet, "ServiceOperator"),
],
"Documents": [
("instruction", views.InstructionViewSet, "Instruction"),
("document", views.DocumentViewSet, "Document"),
],
"Products": [
("productmodel", views.ProductModelViewSet, "ProductModel"),
("productbatch", views.ProductBatchViewSet, "ProductBatch"),
("secondaryproduct", views.SecondaryProductViewSet, "SecondaryProduct"),
("productitem", views.ProductItemViewSet, "ProductItem"),
("productproperties", views.ProductPropertiesViewSet, "ProductProperties"),
("dppdetails", views.DppDetailsViewSet, "DppDetails"),
("metadata", views.MetadataViewSet, "Metadata"),
("alias", views.AliasViewSet, "Alias"),
],
"Materials": [
("material", views.MaterialViewSet, "Material"),
("hazardousmaterial", views.HazardousMaterialViewSet, "HazardousMaterial"),
("composition", views.CompositionViewSet, "Composition"),
],
"Processes and inventory": [
("activity", views.ActivityViewSet, "Activity"),
("manufacturingprocess", views.ManufacturingProcessViewSet, "ManufacturingProcess"),
("productionline", views.ProductionLineViewSet, "ProductionLine"),
("process", views.ProcessViewSet, "Process"),
("backgroundprocess", views.BackgroundProcessViewSet, "BackgroundProcess"),
("productexchange", views.ProductExchangeViewSet, "ProductExchange"),
("envexchange", views.EnvExchangeViewSet, "EnvExchange"),
("emission", views.EmissionViewSet, "Emission"),
("transport", views.TransportViewSet, "Transport"),
],
"Life cycle events": [
("lifecycleevent", views.LifeCycleEventViewSet, "LifeCycleEvent"),
("inspectionevent", views.InspectionEventViewSet, "InspectionEvent"),
("maintenanceevent", views.MaintenanceEventViewSet, "MaintenanceEvent"),
("disassemblyevent", views.DisassemblyEventViewSet, "DisassemblyEvent"),
("itemexchange", views.ItemExchangeViewSet, "ItemExchange"),
],
"Sustainability assessment": [
("indicatorset", views.IndicatorSetViewSet, "IndicatorSet"),
("impactcategory", views.ImpactCategoryViewSet, "ImpactCategory"),
("impactindicator", views.ImpactIndicatorViewSet, "ImpactIndicator"),
("sustainabilityevaluation", views.SustainabilityEvaluationViewSet, "SustainabilityEvaluation"),
("sustainabilityscore", views.SustainabilityScoreViewSet, "SustainabilityScore"),
],
"Circularity assessment": [
("circularityevaluation", views.CircularityEvaluationViewSet, "CircularityEvaluation"),
("circularityindicator", views.CircularityIndicatorViewSet, "CircularityIndicator"),
("circularityscore", views.CircularityScoreViewSet, "CircularityScore"),
("circularityenabler", views.CircularityTrackerViewSet, "CircularityTracker"),
],
}

urlpatterns = [
path(r'', include(router.urls)),
]
router = DefaultRouter()
for tag, routes in ROUTE_GROUPS.items():
for prefix, viewset, basename in routes:
router.register(prefix, extend_schema(tags=[tag])(viewset), basename=basename)

"""
urlpatterns = [
path('productionlines/', views.ProductionLinesListCreate.as_view(), name="production-view-create"),
path('productionlines/<int:pk>', views.ProductionLineHandle.as_view(), name="handle-productionline"),
path('processes/', views.ProcessCreate.as_view(), name="process-view-create"),
path('processes/search/', views.ProcessSearch.as_view(), name='process-search'),
path(r'', include(router.urls)),
]
"""
Loading
Loading