The API endpoints documentation can be found here The developper documentation of django_modelapiview (which is the core of our API) is available on pypi or on its repository
HTTP Status Codes matches these ones
We are using the Payal-Python-SDK V1
The docker-compose.yml file provided is only working for a development environment.
Use docker-compose up to start the container
and docker-compose down to stop it
Note:
-
Display rules:
- Empty / not used files are not listed below
-
Common directories and files:
- __pycache__/ directories are python files compiled
- __init__.py files are python module files
- admin.py files are application interaction with the backoffice description
- apps.py files are Django required for applications detection
- forms files are forms class based description
- models files describe the database using the Django ORM
- tests.py files are unitary tests
api # Project directory
└───api # API application
│ └───migrations # List the migrations needed to update the db
| | ...
| |
│ │ admin.py # API interaction on the backoffice
│ │ apps.py
endpoints
│ │ models.py # API database classes described
│ │ responses.py # Base classes for API responses
│ │ tests.py
│ │ urls.py # API endpoints description
│ │ views.py # API endpoints logic
|
└───eip # EIP application
│ └───migrations
| | ...
| |
| | admin.py # EIP interaction on the backoffice
| | apps.py
| | models.py # EIP database classes described
| | tests.py
|
└───split # Project application
| | admin.py # Backoffice configuration
| | apps.py
| | forms.py
| | settings.py
| | urls.py
| | views.py # Additional backoffice views
| | wsgi.py
|
└───split_dashboard # Application to configure the Django admin site
│ └───templates
| └───admin # Django backoffice override
| | base_site.html # Base template override
| |
| └───split # Additional templates
| | user_update_profile.html # User update template
| | dashboard.py # The Dashboard class child to override Django JET default one
| | forms.py # The user form used in the profile page
| | modules.py # New Django JET modules to display Calendar, Documentation and Requests graphs
| | views.py # The user profile view
| |
|
└───static # Django collected static files for production
│ └───admin
| └───css
| └───fonts
| └───img
| └───js
|
| Dockerfile # Docker API container configuration
| manage.py # Django commands entry point
| README.md # This description file
| requirements.txt # Project modules required list for pip -r. We are using a custom package (django_modelapiview) as heart of our api
│