nwon_django_toolbox 0.1.2

Some Django Wizardry

NWON Python baseline package

This package provides some basic python functions that can be used across several projects.

The dependencies of the project are kept to a minimum in order to prevent version conflicts with other projects.

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:

1. Tell poetry to create dependencies in a .venv folder withing the project: poetry config virtualenvs.in-project true
2. Create a virtual environment using the local python version: poetry env use $(cat .python-version)
3. Install dependencies: poetry install

Prepare Package

As we want to include types with the package it is not as straight forward as just calling poetry build 😥.

We need to:

1. Clean dist folder
2. Bump up the version of the package
3. Build the package

Luckily we provide a script for doing all of this python scripts/prepare.py patch. Alternatively you can run the script in a poetry context poetry run prepare patch. The argument at the end defines whether you want a patch, minor or major version bump.

The final zipped data ends up in the dist folder.

Publish Package

Test package publication

1. Add test PyPi repository: poetry config repositories.testpypi https://test.pypi.org/legacy/
2. Publish the package to the test repository: poetry publish -r testpypi
3. Test package: pip install --index-url https://test.pypi.org/simple/ nwon_baseline

If everything works fine publish the package via poetry publish.