Skip to content

♻️ changeslink

Github Actions Circle CI pypi version # of downloads codecov.io Scrutinizer Code Quality Gitter

🎵 Ch-ch-changes 🎵

changes

⚡️ Quickstartlink

Install changes with pipx:

pipx install changes

$ changes --help
Usage: changes [OPTIONS] COMMAND [ARGS]...

  Ch-ch-changes

Options:
  -V, --version  Show the version and exit.
  --verbose      Enables verbose output.
  --dry-run      Prints (instead of executing) the operations to be performed.
  -h, --help     Show this message and exit.

Commands:
  publish  Publishes a release
  stage    Stages a release
  status   Shows current project release status.

📺 Demolink

Expand changes demo

🛠 Developmentlink

Use the Makefile targets to test, lint and generate the docs:

$ make
ci               Continuous Integration Commands
clean            Remove Python file artifacts and virtualenv
docs             Generate documentation site
lint             Lint source
serve            Serve documentation site
test             Run tests
venv             Creates the virtualenv and installs requirements

📖 CLI Referencelink

statuslink

Shows current project release status.

Usage:

status [OPTIONS] [REPO_DIRECTORY]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

stagelink

Stages a release

Usage:

stage [OPTIONS] [REPO_DIRECTORY] [RELEASE_NAME] [RELEASE_DESCRIPTION]

Options:

Name Type Description Default
--draft boolean Dry-run mode. False
--discard boolean Discards the changes made to release files False
--help boolean Show this message and exit. False

publishlink

Publishes a release

Usage:

publish [OPTIONS] [REPO_DIRECTORY]

Options:

Name Type Description Default
--help boolean Show this message and exit. False

🌟 Built withlink

  • tox - standardize testing in Python
  • poetry - Python dependency management and packaging made easy
  • pytest - helps you write better programs
  • pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.

  • mkdocs - Project documentation with Markdown.

  • click - A Python package for creating beautiful command line interfaces in a composable way with as little code as necessary

  • requests - Requests is the only Non-GMO HTTP library for Python, safe for human consumption