Welcome to the project_release package documentation

https://img.shields.io/pypi/v/project-release https://img.shields.io/readthedocs/project-release https://img.shields.io/github/license/jmlemetayer/project-release https://img.shields.io/github/actions/workflow/status/jmlemetayer/project-release/build-and-publish.yml?branch=main https://img.shields.io/github/actions/workflow/status/jmlemetayer/project-release/pytest-and-coverage.yml?branch=main&label=test https://results.pre-commit.ci/badge/github/jmlemetayer/project-release/main.svg https://img.shields.io/codecov/c/gh/jmlemetayer/project-release/main

A tool to help releasing projects.

Installation

Using pip:

pip install project-release

Usage

  • Inside your project, create a file .project-release-config.yaml.

  • A very basic configuration can be generated with project-release sample-config.

  • All options are documented in the Configuration page.

  • Once configured, a project can be released by executing project-release.

License

The project_release module is released under the MIT License.