Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
123 lines (83 loc) · 4.36 KB

DEVELOPMENT.md

File metadata and controls

123 lines (83 loc) · 4.36 KB

Development

Unit Testing

We are measuring the coverage of the unit tests & expect a minimum coverage of 95% - otherwise the pipeline job for the unit test execution will fail accordingly.
Please ensure you've added unit tests whenever adding new source code to the project.

Release Creation

Precondition

  • You are required to have an account for PyPi.
  • Additionally, check that you have required permissions for the projects at PyPi & GitHub!
  • Check that all pipeline-checks did pass, your code changes are ready and everything is already merged to the main branch!
  • Your local git configuration must work - check your authentication!

Preferred - Using Shell Script for Release Creation

In the root directory of this repository you will find a script called create_release.sh. When executing this script, it expects exactly one argument: the new name of the release / tag. Here you need to provide always the syntax X.X.X, e.g. 0.1.9, 0.5.0 or 1.0.0.

The script will do two things automatically for you:

  1. Updating the version string in the __about__.py
  2. Creating & Pushing a new tag to GitHub.

Execute the following command to create a new release:

cd <project-root-directory>
./create_release.sh 1.0.0

After executing the script, three pipeline jobs are getting triggered automatically:

  1. First job creates a new Release in github with the name of the created Tag.
  2. Second job uploads the new wheel package to PyPi with the __version__ from the __about__.py file.
  3. Third job generates a new keyword documentation via libdoc on the main branch, but pushes it to the gh_pages where it is available as public GitHub Page.

Backup - Manual Version Bump & Tag Creation

If the preferred way using the create_release.sh script does not work, you can also manually create a new release. Therefore, execute the following steps.

1. Increase Version

Open the file __about__.py and increase the version (0.0.5 = major.minor.path) before building & uploading the new python wheel package!

The new version must be unique & not already existing in PyPi & GitHub Releases!!!

Commit & push the changed version into the main branch of the repository.

2. Create new Tag

Now, create a new tag from the main branch with the syntax vX.X.X -> example: v1.0.5.

Use the following commands to create & push the tag:

git tag v0.0.5
git push origin v0.0.5

2.1. Creating GitHub Release & Deploy Wheel Package to PyPi

After pushing the new tag, three pipeline jobs are getting triggered automatically:

  1. First job creates a new Release in github with the name of the created Tag.
  2. Second job uploads the new wheel package to PyPi with the __version__ from the __about__.py file.
  3. Third job generates a new keyword documentation via libdoc on the main branch, but pushes it to the gh_pages where it is available as public GitHub Page.

Installing Dev Dependencies

Contributing to this project & working with it locally, requires you to install some dev dependencies - use the following command in the project root directory:

pip install -e .[dev]

Afterwards, the table library gets installed in editable mode & you will have a dev dependencies installed.

Hatch

You will need the python package tool hatch for several operations in this repository. Hatch can be used to execute the linter, the tests or to build a wheel package.

Use the following command:

pip install hatch

Ececute Linting Checks via ruff

hatch run dev:lint

Execute Acceptance & Unit Tests via Robot Framework & PyTest

hatch run dev:atest
hatch run dev:utest

Generate Docs via libdoc

hatch run dev:docs

pre-commit

When starting to work on this library, please ensure you have installed the development requirements from the readme.md.

Once you have them installed, please execute the following shell command:

pre-commit install

This will activate the .pre-commit-config.yaml from your rootdirectory.

Run pre-commit manually from shell

You can run the configured pre-commit hook manually with the following shell command:

pre-commit run --all-files