jEAP CI/CD Python Library Documentation
Welcome to the jEAP CI/CD Python library.
This project provides a collection of reusable Python modules designed to support and standardize CI/CD pipeline operations in the jEAP context.
For more details about the library, please refer to the modules documentation.
Local Development
Setup
-
Clone the repository:
git clone https://github.com/jeap-admin-ch/jeap-python-pipeline-lib.git cd jeap-python-pipeline-lib
-
Create a virtual environment and activate it:
python3 -m venv venv source venv/bin/activate
-
Install the dependencies:
pip install -r requirements.txt
-
Install the needed tools:
pip install build twine pip-licenses pytest
Development basics
-
Adding New Modules:
- Create a new Python file in the
src/jeap_pipeline/directory. - Ensure the new module has a corresponding test file in the
tests/directory. - Follow the naming conventions and structure of existing modules.
- Create a new Python file in the
-
Writing Documentation:
- Add docstrings to all public classes and functions.
- Update the
CHANGELOG.mdwith any new features or changes. - If necessary, add detailed documentation in the
docs/directory.
-
Changing the Version:
- Update the version number in the
pyproject.tomlfile. - Ensure the version number complies with semantic versioning and the PEP 440 standard.
- Update the version number in the
-
Add new dependencies:
- Add the dependency to the
requirements.txtfile. - Additionally add the dependency into the
pyproject.tomlinto the section[project.dependencies]or[project.optional-dependencies]for dev dependencies. - Ensure the license of the dependency is compatible with the project's license.
- Keep the THIRD-PARTY-LICENSES.md file up to date.
- Add the dependency to the
Build
To combine the build with automated testing and the generation of the THIRD-PARTY-LICENSES.md file, run the following command:
python3 scripts/full_build.py
If you would like to execute single steps, you can use the following commands. A more comprehensive documentation can be found here: https://packaging.python.org/en/latest/tutorials/packaging-projects/
Install the build tool via pip. Make sure you have the latest version of PyPA’s build installed:
pip install build
To create the package run this command from the same directory where pyproject.toml is located:
python -m build
This command should generate two files in the dist directory. The tar.gz file is a source distribution whereas the .whl file is a built distribution.
Test
To run the tests, use the following command:
python3 -m pytest
Upload
It should be noted that the publishing process takes place automatically in the pipeline. The following steps are only necessary for manual publishing.
First install twine via pip:
python3 -m pip install --upgrade twine
Once installed, run Twine to upload all the archives under dist:
python3 -m twine upload --repository testpypi dist/*
Use testpypi to upload the package to test instance of PyPI. To upload to the real PyPI repository, use pypi instead of testpypi. You will be prompted for an API token. Use the token value, including the pypi- prefix.
Package installation
You can use pip to install your package and verify that it works. Create a virtual environment and install your package from TestPyPI:
python3 -m pip install -i https://test.pypi.org/simple/ jeap-pipeline==0.1.0
Check licenses of dependencies and generate THIRD-PARTY-LICENSES.md
To check the licenses of the dependencies and generate the THIRD-PARTY-LICENSES.md file, run the following command:
python3 scripts/check_licenses.py --target-python .venv/bin/python
Publishing
Versioning
The version can be set in the pyproject.toml file. The version number has to comply with semantic versioning and the PEP 440 standard. Please make sure to also update publiccode.yml and CHANGELOG.md accordingly.
On every push a CI pipeline is triggered, which builds and uploads the artifact to the (test)-pypi repository.
- On the main branch, the version number remains unchanged and the artifact is published as a stable release to pypi.
- On feature branches, a valid development release suffix (
.dev<timestamp>) is added to the version. The artifact is published to TestPyPI.
Publishing via GitHub Actions
The publishing process is automated using GitHub Actions. The CI pipeline is defined in the .github/workflows/publish.yml file. The key steps involved are:
- Setup Python Environment: The pipeline sets up the Python environment using the specified version in the
pyproject.tomlfile. - Install Dependencies: All necessary dependencies are installed using
pip. - Run Tests: The test suite is executed to ensure the code is functioning as expected.
- Generate Version: The version number is generated based on the branch name.
- Generate License File: The license file is generated using the
third_party_license_file_generatortool. - Build Package: The package is built using
python -m build. - Upload to PyPI: The built package is uploaded to PyPI or TestPyPI using
twine.
Project Files
-
LICENSEContains the license information for the project. -
MANIFEST.inSpecifies additional files to include in the distribution package. -
pyproject.tomlModern configuration file for build systems. Contains metadata and dependencies of the project. -
publiccode.ymlPublic code metadata file following the publiccode.yml specification for open source projects. -
requirements.txtLists the dependencies for development and testing. -
THIRD-PARTY-LICENSES.mdGenerated file that lists the licenses of third-party dependencies.
1 maintainer
Metadata
1 maintainer
Release files for jeap-pipeline 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| jeap_pipeline-1.2.0.tar.gz | 40.4 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jeap_pipeline-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 68.9 kB
Release files / jeap_pipeline-1.2.0.tar.gz
| Download URL | jeap_pipeline-1.2.0.tar.gz |
|---|---|
| Size | 40.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
21b6f004d694cddea8161f6f28b080feff18efcdc7f6e559c71686a8308fa0ac
|
|
BLAKE2b-256 checksum How to use checksums |
301a248a4a270f57a87623585016ef5b0c2f8f2e681ba635a053d809b4b60a6b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logRelease files / jeap_pipeline-1.2.0-py3-none-any.whl
| Download URL | jeap_pipeline-1.2.0-py3-none-any.whl |
|---|---|
| Size | 28.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
620d55de40c77e4f329a35aaae197ec1089d176fff7093713323bf82b10a2aba
|
|
BLAKE2b-256 checksum How to use checksums |
1361f311e29ddca100802a51a6c3fdc544c2b2be7d2066a7daf538b1ec7933ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logSecurity for jeap-pipeline 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for jeap_pipeline-1.2.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
