Groupeffect Pypi development

This project is a workflow configuration to setup python packages in a dockerized environment.

It contains a pypi package and development scripts to push test and prod packages.

The main pypi package is saved under framework/pypi/app/package/groupeffect

The package README.md can be found under:

https://github.com/Groupeffect/groupeffect-pypi/blob/main/framework/pypi/app/package/README.md

Docker environment

docker-compose or podman-compose up

podman-compose build
podman-compose -f docker-compose.yaml up
podman-compose -f docker-compose.yaml up --build --remove-orphans

Development scripts

framework/pypi/app/run.sh : run server for interactive usage
framework/pypi/app/dev.sh : create package dist and install locally
framework/pypi/app/setup.sh : create package dist and push to test.pypi

Pypi

Always update version number !!!

You will find a handy py script for automated version updates under

framework/pypi/app/package/manage.py

run: python framework/pypi/app/package/manage.py

to update and overwrite following files:

this file has the current version number and you can change it manually

framework/pypi/app/package/VERSION.json

this file is used for packing do NOT change it manually !

framework/pypi/app/package/setup.cfg

Authentication for Pypi

use framework/.pypirc for pypi and twine authentication

see example framework/.pypirc_example

Packaging

https://packaging.python.org/en/latest/tutorials/packaging-projects/

Test package

twine check:

twine check dist/*

load test package:

use setup.cfg for django apps

python setup.py sdist

python3 -m twine upload --repository testpypi dist/*

Once uploaded, your package should be visible on TestPyPI; for example:

https://test.pypi.org/project/groupeffect
install test package:

pip install -i https://test.pypi.org/simple groupeffect

Test the app in django test project:

go to:

framework/pypi/app/package/tests/testapp

and run django commands:

python manage.py makemigrations

python manage.py migrate

Production

check the Version, and adjust VERSION.json to the current available version number then run framework/pypi/app/setup.sh to update files and version. Always run tests before uploading a package.

load prod package:

use setup.cfg for django apps

python setup.py sdist

use pyproject.toml for regular packages

python -m build

THEN

python -m twine upload dist/*

python -m twine upload --repository pypi dist/* --verbose

install prod package:

pip install groupeffect