NWON-Django-Toolbox
This package provides some Django additions that can be used across several projects.
Settings
The Django Toolbox can be configured using the Django settings. We expect the key NWON_DJANGO that holds a dictionary. The dictionary must be of type NWONDjangoSettings that comes with this package (nwon_django_toolbox.nwon_django_settings). The keys mus be snake case or camel case.
For example like this
NWON_DJANGO: NWONDjangoSettings = {
"authorization_prefix": "Bearer",
"logger_name": "your-log-name",
"application_name": "application"
}
Dependencies
The project has a bunch of dependencies that we use in most of our projects. In the end we have quite a lot and need to slim this down in the future.
Django related libraries are:
- Django (Obviously 🧠)
- django-polymorphic
- django-json-widget
- django-rest-polymorphic
For API documentation our models and serializer support two library which come as a dependency as well:
- drf-spectacular
- drf-yasg
On top we use a bunch of helper libraries
- Pydantic
- Pillow
- jsonref
- jsonschema-to-openapi
- pyhumps
- nwon-baseline
Package is meant for internal use at NWON as breaking changes may occur on version changes. This may change at some point but not for now 😇.
Development Setup
We recommend developing using poetry.
This are the steps to setup the project with a local virtual environment:
- Tell poetry to create dependencies in a
.venvfolder withing the project:poetry config virtualenvs.in-project true - Create a virtual environment using the local python version:
poetry env use $(cat .python-version) - Install dependencies:
poetry install
Get ready to publish
You will need a token to publish packages. They can be obtained from here: [https://pypi.org/manage/account/token/](PyPi Account)
Set the token locally using: poetry config pypi-token.pypi pypi-XXXXXXXXXXXXXXXXXXXXXXXXXXXX
Publish Package
Test package publication
- Add test PyPi repository:
poetry config repositories.testpypi https://test.pypi.org/legacy/ - Publish the package to the test repository:
poetry publish -r testpypi - Test package:
pip install --index-url https://test.pypi.org/simple/ nwon_baseline
If everything works fine publish the package via poetry publish [patch|minor|major] --publish.
1 maintainer
Release files for nwon_django_toolbox 0.7.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nwon_django_toolbox-0.7.3.tar.gz | 799.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nwon_django_toolbox-0.7.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 869.1 kB
Release files / nwon_django_toolbox-0.7.3.tar.gz
| Download URL | nwon_django_toolbox-0.7.3.tar.gz |
|---|---|
| Size | 799.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1343ac532515378694de746f60a13902c7e8fc4aecab44e1c499264512afd23d
|
|
BLAKE2b-256 checksum How to use checksums |
45560789d5499d9cf50245411cd5fcc83d85db72f5347f3627f05e5288cfabbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.1 CPython/3.11.6 Linux/6.5.0-45-generic
|
Release files / nwon_django_toolbox-0.7.3-py3-none-any.whl
| Download URL | nwon_django_toolbox-0.7.3-py3-none-any.whl |
|---|---|
| Size | 69.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f0beae1c3109ee2bf550d9cf566319ad069e42c173324d1e7c5d524ddacbb608
|
|
BLAKE2b-256 checksum How to use checksums |
be7ac7a66135a85e88b71dcf9e9231958b8221e62b414e0a4a2131674d2f1f30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.1 CPython/3.11.6 Linux/6.5.0-45-generic
|
