publicator 0.2.1

No project description provided

🗞 Publicator

A better poetry publish experience.

Features

Supported

• Ensures you are publishing from your release branch (main and master by default)
• Ensures the working directory is clean and latest changes are pulled
• Reinstalls dependencies to ensure your project works with the latest dependency tree
• Ensures your Python version is supported by the project and its dependencies
• Runs the tests
• Bumps the version in pyproject.toml and creates a Git tag based on it
• Publishes the new version to Python Package Index or custom repository
• Pushes commits and tags (newly & previously created) to your Git server
• See what will be executed with preview mode, without pushing or publishing anything remotely

Planned

• Open a prefilled GitHub Releases draft after publishing

Prerequisites

• Python 3.8 or later
• Poetry 1.1 or later
• Git 2.11 or later

Install

Install with pipx.

pipx install publicator

Usage

Usage: publicator [OPTIONS] version

Arguments:
  version  can be one of (patch | minor | major | 1.2.3)  [required]

Options:
  --repository name               Custom repository for publishing (must be
                                  specified in pyproject.toml)
  --any-branch / --no-any-branch  Allow publishing from any branch  [default:
                                  no-any-branch]
  --skip-cleaning / --no-skip-cleaning
                                  Skip repository clean up  [default: no-skip-
                                  cleaning]
  --yolo / --no-yolo              Skip reinstall and test steps  [default: no-
                                  yolo]
  --skip-tag / --no-skip-tag      Skip creating a new tag  [default: no-skip-
                                  tag]
  --skip-publish / --no-skip-publish
                                  Skip publishing the package to the registry
                                  [default: no-skip-publish]
  --skip-push / --no-skip-push    Skip pushing commits and tags to Git
                                  [default: no-skip-push]
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Contributing

See here for instructions.