diff --git a/docs/contributing.md b/docs/contributing.md index 1c6ba5ecfdc8608ba2d51f0f346364c6afb4253c..708f4adc2d80edf1a18ad7eb113fa80d4a492c7b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -67,6 +67,13 @@ To run tests using `pytest`, use: hatch run pytest ``` +## Running the CLI +The package provides a command-line interface (CLI) entry point. + +```sh +acmc --help +``` + ### All code checks The project run all type and formatting checking @@ -103,13 +110,30 @@ To build the package, use: hatch build ``` -## Running the CLI -The package provides a command-line interface (CLI) entry point. +## Releasing the Package + +Update the version number in pyproject.toml + +Build the package using: ```sh -acmc --help +hatch build ``` +Creates file `acmc-<version>-py3-none-any.whl` in the `./dist` directory + +Check package using: + +```sh +twine check dist/acmc-<version>-py3-none-any.whl +``` +Upload to pypi using: + +```sh +twine upload dist/acmc-<version>-py3-none-any.whl --username __token__ --password <your pypi token> +``` + + ## Contributing ### GitLab Basic Workflow Overview