agileetc

Example python 3.9+ project where we can develop best practices and provide teams with a useful template with the following features:

• Poetry packaged python project with example CLI entry point.
• Linux and Windows compatible project.
• Example read/write YML files.
• Example Unit Tests.
• Example flake8 linter configuration.
• Example line operation via click API allowing project to be run from command line of from CICD pipelines.
• Example use of Fabric API to execute external commands.
• Example use of Texttable for pretty table output.
• Example GoCD pipeline.
• Example GitHub actions.
• Python package publishing to PiPy.
• Docker image publishing to docker hub.
• Example usage of python package.
• Example usage of docker image.

Prerequisites

This project uses poetry is a tool for dependency management and packaging in Python. It allows you to declare the libraries your project depends on, it will manage (install/update) them for you.

Use the installer rather than pip installing-with-the-official-installer.

poetry self add poetry-bumpversion

poetry -V
Poetry (version 1.2.0)

Getting Started

poetry update

poetry install

Run

poetry run agileetc

Lint

poetry run flake8

Test

poetry run pytest

Publish

• By default we are using PYPI packages.
• Create yourself an access token for PYPI and then follow the instructions.

export PYPI_USERNAME=__token__ 
export PYPI_PASSWORD=<Your API Token>
poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Releasing

We are using poetry-bumpversion to manage release versions.

poetry version patch

Dependency

Once the release has been created it is now available for you to use in other python projects via:

pip install agileetc

And also for poetry projects via:

poetry add aigleetc

Continuous Integration

The objects of each of the example CI pipelines here are to:

• Lint the python code.
• Run Unit Tests
• Build package.
• Release package, bumping the version.
• Publishing in new package version.

GitHub Actions

The example GitHub actions CI for this project is located in file .github/workflows/python-ci.yml and is available from the GitHub dashboard. This CI is setup to run via a local runner which should be configured.

Jenkins

GoCD

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details