- Develop a feature and the DB architecture to support it from the already existing models and components of the platform. The approximative design of what the front end would look like is provided.
I have used Django Rest Framework to build the API and PostgreSQL as a database.
I spent a lot of time about the clean architecture and understanding how emissions works.
Yea I didn't manage my time properly and I didn't have enough time to do the bonus part. But all the requirements are done.
Some things are not really clear to me (when I read the requirements I thought it was clear but when I started to code I was confused) so I made some assumptions.
I hope you will like it, and you will give me feedback.
Create a projection tool to allow our experts to design reduction strategies for our clients. The usual carbon report would have several sources attached to it. The tool would allow to register potential modification to those sources. Implementation should:
- include additional/modified models
- include endpoints (DRF) for specific data
- be implemented using the Django framework
- pay extra care to optimization
- Allow to plan a modification to a source (either by applying a ratio to the value or changing the emission_factor (EF) value)
- Modifications could be in series e.g. I first reduce my value by 2 then I change the EF from 42 to 3.14 (switch from diesel to electric let's say)
- Provide information regarding the delta in total_emission regarding the source
- Provide information regarding the delta in total_emission for the report
- For source s with lifetime s (capital goods) the amortization should be considered: total_emission are divided along the lifetime of the source after lifetime years the total_emission displaied is 0 making a modification on a source with lifetime means that the original source could already be amortized
e.g. bought 1 car (lifetime 5 years) in 2020, if I buy another one in 2022 (with a modification) both will be showed in the total emissions displaied for my modification. If it's in 2028, only the second one will be showed
- When retrieving an information (by source or report ) we should be able to specify a year (attention to lifetime )
- We should be able to retrieve data for a range of years (by source or report ) within a dict with the year as a key and the emissions as a value
- We could have several reduction strategies by report
- New source could be added in reduction strategies
- Modifications could be progressive, the growth should be partially showed when the year fits the time the growth started. e.g. I'll double my source by 2024
- Script to generate a dummy DB
- Fix the bug in
total_emission -
The total emission is not calculated correctly when the source is modified.
Base URL : https://tapio.fly.dev/
- Route:
/api/v1/reports/ - Method:
POST - Body:
{
"name": "string",
"date": "Date (mm/dd/yyyy)"
}- Response:
{
"id": 1,
"message": "Report created successfully",
"data": {
"name": "string",
"date": "2023-11-03"
}
}- Route:
/api/v1/reports/ - Method:
GET - Query Params:
?year=2023or?from_year=2023&to_year=2024 - Response:
{
"details" : "Reports from {year} to {year}",
"data": [
{
"id": 1,
"name": "string",
"date": "2023-11-03"
},
{
"id": 2,
"name": "string",
"date": "2023-11-03"
}
]
}- Route:
/api/v1/reports/{id}/ - Method:
GET - Response:
{
"total_emission_report": 140.0,
"data": {
"id": 2,
"name": "Unity",
"date": "2023-05-30",
"sources": [
{
"id": 10,
"description": "Description for Australia",
"value": 10.0,
"emission_factor": 5.0,
"total_emission": 80.0,
"lifetime": 10,
"acquisition_year": 2020,
"report": {
"id": 2,
"name": "Unity",
"date": "2023-05-30"
}
},
{
"id": 17,
"description": "Description for France",
"value": 10.0,
"emission_factor": 6.0,
"total_emission": 60.0,
"lifetime": 7,
"acquisition_year": 2021,
"report": {
"id": 2,
"name": "Unity",
"date": "2023-05-30"
}
}
]
}
}- Route:
/api/v1/reports/{id}/ - Method:
PUT - Body:
{
"name": "string",
"date": "Date (mm-dd-yyyy)"
}- Response:
{
"id": 2,
"name": "string",
"date": "2023-05-30"
}- Route:
/api/v1/reports/{id}/ - Method:
DELETE - Response:
{
"message": "Report deleted successfully"
}- Route:
/api/v1/reports/sources/ - Method:
POST - Body:
{
"description": "string",
"value": 0,
"emission_factor": 0,
"lifetime": 0,
"acquisition_year": 0,
"report": "Report ID"
}- Response:
{
"data": {
"description": "string",
"value": 2.0,
"emission_factor": 5.0,
"lifetime": 9,
"acquisition_year": 2020,
"report": 2
},
"emission_with_calcul": 10.0,
"emission_without_calcul": 10.0,
"formula": "value * emission_factor",
"id": 25
}- Route:
/api/v1/reports/sources/ - Method:
GET - Query Params:
?year=2023or?from_year=2023&to_year=2024 - Response:
{
"details" : "Sources from {year} to {year}",
"data": [
{
"id": 1,
"description": "string",
"value": 2.0,
"emission_factor": 5.0,
"total_emission": 10.0,
"lifetime": 9,
"acquisition_year": 2020,
"report": 2
},
{
"id": 2,
"description": "string",
"value": 2.0,
"emission_factor": 5.0,
"total_emission": 10.0,
"lifetime": 9,
"acquisition_year": 2020,
"report": 2
}
]
}- Route:
/api/v1/reports/sources/{id}/ - Method:
GET - Query Params:
?year=2023 - Response:
{
"id": 1,
"description": "string",
"value": 2.0,
"emission_factor": 5.0,
"total_emission": 10.0,
"lifetime": 9,
"acquisition_year": 2020,
"report": {
"id": 2,
"name": "string",
"date": "2023-05-30"
}
}- Route:
/api/v1/reports/sources/{id}/ - Method:
PUT - Body:
{
"description": "string",
"value": 0,
"emission_factor": 0,
"lifetime": 0,
"acquisition_year": 0,
"report": "Report ID"
}- Response:
{
"id": 1,
"description": "string",
"value": 2.0,
"emission_factor": 5.0,
"total_emission": 10.0,
"lifetime": 9,
"acquisition_year": 2020,
"report": 2
}You can also set a ratio to the value or change the emission factor of a source
- Body:
{
"modifications": [
{
"ratio": 0.5,
"emission_factor": 5.0
},
{
"ratio": 0.5,
"emission_factor": 6.0
}
]
}- Response:
{
"plan_modification": {
"message": "Value updated",
"new_value": 12.5,
"ratio": 0.5,
"formula": "value * ratio"
},
"emission_factor_modification": {
"message": "Emission factor updated",
"new_emission_factor": 6.0,
"new_total_emission": 75.0,
"formula": "value * emission_factor"
},
"list_of_modifications": [
{
"ratio": 0.5,
"emission_factor": 5.0
},
{
"ratio": 0.5,
"emission_factor": 6.0
}
],
"average_annual_emission": 7.5,
"amortized_emission": 75.0,
"total_emission": 75.0,
"lifetime": "Lifetime not exceeded",
"data": {
"id": 1,
"description": "Vehicule",
"value": 12.5,
"emission_factor": 6.0,
"total_emission": 75.0,
"lifetime": 10,
"acquisition_year": 2023,
"report": 1
},
"delta_total_emission": -150.0
}- Route:
/api/v1/reports/sources/{id}/ - Method:
DELETE - Response:
{
"message": "Source deleted successfully"
}