Package: ievv-auth
Ievv authLibrary for managing api keys and json web tokensDocumentation and guidesDevelopRequires:https://github.com/pyenv/pyenvUse conventional commits for GIT commit messagesSeehttps://www.conventionalcommits.org/en/v1.0.0/.
You can use this git commit message format in many different ways, but the easiest is:Use commitizen:https://commitizen-tools.github.io/commitizen/commit/Use an editor extension, likehttps://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commitsfor VScode.Just learn to write the format by hand (can be error prone to begin with, but it is fairly easy to learn).Install hatch and commitizenNOTE: You only need hatch if you need to build releases, and you
only need commitizen for releases OR to make it easy to follow
conventional commits for your commit messages
(seeUse conventional commits for GIT commit messagesabove).First install pipx with:brewinstallpipx
pipxensurepathThen install hatch and commitizen:pipxinstallhatchpipxinstallcommitizenSeehttps://github.com/pypa/pipx,https://hatch.pypa.io/latest/install/andhttps://commitizen-tools.github.io/commitizen/for more install alternatives if
needed, but we really recommend using pipx since that is isolated.Install development dependenciesInstall a local python version with pyenv:pyenvinstall3.10
pyenvlocal3.10Create virtualenv./tools/recreate-virtualenv.shAlternatively, create virtualenv manually (this does the same as recreate-virtualenv.sh):python-mvenv.venvthe ./tools/recreate-virtualenv.sh script is just here to make creating virtualenvs more uniform
across different repos because some repos will require extra setup in the virtualenv
for package authentication etc.Install dependencies.venv/bin/pipinstall-e".[dev,test]"Upgrade your local packagesThis will upgrade all local packages according to the constraints
set in pyproject.toml:pipinstall--upgrade--upgrade-strategy=eager".[dev,test]"RunserverStartpythonmanage.pyrunserverTo wipe out the database delete the database (dbdev.sqlite3) and run:pythonmanage.pymigrate
pythonmanage.pyrunserverRun testssource.venv/bin/activate# enable virtualenvpytestievv_authHow to release ievv_authFirst make sure you have NO UNCOMITTED CHANGES!Release (create changelog, increment version, commit and tag the change) with:czbump
gitpush&&gitpush--tagsNOTE (release):cz bumpautomatically updates CHANGELOG.md, updates version file(s), commits the change and tags the release commit.If you are unsure about whatcz bumpwill do, run it with--dry-run. You can use
options to force a specific version instead of the one it automatically selects
from the git log if needed, BUT if this is needed, it is a sign that someone has messed
up with their conventional commits.cz bumponly works if conventional commits (see section about that above) is used.cz bumpcan take a specific version etc, but it automatically select the correct version
if conventional commits has been used correctly. Seehttps://commitizen-tools.github.io/commitizen/.If you need to add more to CHANGELOG.md (migration guide, etc), you can just edit
CHANGELOG.md after the release, and commit the change with adocs: some useful messagecommit.Theczcommand comes fromcommitizen(install documented above).What if the release fails?SeeHow to revert a bumpin thecommitizen FAQ.Release to pypi:Pypi now require a token for login, go topypiand create a token. You will be promted to enter this after running publish below.hatchbuild-tsdist
hatchpublish-u__token__
rmdist/*# optional cleanup