neos-common 0.14.13

Neos Common Code

NEOS Platform Common Code v0.14.13

Prerequisites

The following packages are used across python repositories. A global install of them all is highly recommended.

• uv
• Invoke

WSL

If running on Windows, you may need to install distutils to install the service.

$ sudo apt-get install python3.8-distutils

Initial setup

$ invoke install-dev

Install on MacOS

• Install kafka dependencies

$ brew install librdkafka

• Setup environment variables on .bashrc or .zshrc

export CFLAGS="-I/opt/homebrew/include"
export LDFLAGS="-L/opt/homebrew/lib"
export LIBRARY_PATH="/opt/homebrew/lib"

• Execute the following command to install the dependencies

$ invoke install-dev

Code Quality

Tests

invoke tests
invoke tests-coverage

Linting

invoke check-style
invoke isort

Releases

Release management is handled using changelog-gen. The below commands will tag a new release, and generate the matching changelog entries. Jenkins will then publish the release to the artifact repository.

$ invoke release
$ invoke bump-patch
$ invoke bump-minor
$ invoke bump-major
> vX.Y.Z