cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance 0.0.0

Cookiecutter Cruft Poetry Tox Pre Commit Ci Cd Instance

cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance

Overview

• TODO

Features

• TODO

Requirements

• TODO

---

Table of Contents

Installation

You can install Cookiecutter Cruft Poetry Tox Pre Commit Ci Cd Instance via pip:

pip install cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance

Usage

• TODO
  • High-level usage overview

---

• TODO
  • Step 0 description

import cookiecutter_cruft_poetry_tox_pre_commit_ci_cd_instance

# TODO

Development

For convenience, many of the below processes are abstracted away and encapsulated in single make targets.

Tip: invoking make without any arguments will display auto-generated documentation on available commands.

Package and Dependencies Installation

Note: poetry is a required dependency.

To install the package and all dev dependencies, run:

make provision_environment

Testing

We use tox for our automation framework and pytest for our testing framework. To invoke the tests, run:

make test

Code Quality

We are using pre-commit for our code quality static analysis automation and management framework. To invoke the analyses and auto-formatting over all version-controlled files, run:

make lint

Note: CI will fail if either testing or code quality fail, so it is recommended to automatically run the above locally prior to every commit that is pushed.

Automate via Git Pre-Commit Hooks

To automatically run code quality validation on every commit (over to-be-committed files), run:

make install-pre-commit-hooks

Note: This will prevent commits if any single pre-commit hook fails (unless it is allowed to fail) or a file is modified by an auto-formatting job; in the latter case, you may simply repeat the commit and it should pass.

Summary

• TODO

Further Reading

• TODO

---

Legal

License

cookiecutter-cruft-poetry-tox-pre-commit-ci-cd-instance is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Credits

This project was generated from @TeoZosa's cookiecutter-cruft-poetry-tox-pre-commit-ci-cd template.