Skip to main content

Local-first release CLI tools: ship_bump, ship_pypi, ship_release_gh

Project description

fastship

Tiny, local-first release tools for modern Python projects.

fastship gives you the same workflow feel as the nbdev nbdev-bump-version, release-pypi, and release-gh commands — but for plain (non-notebook) Python projects.

Install

pip install fastship

Quick start

Create a new project:

ship-new my-project
cd my-project
pip install -e .[dev]

This creates a complete project with pyproject.toml, __version__, LICENSE, README, and everything wired for fastship.

Commands

ship-bump

Bump a version part (0=major, 1=minor, 2=patch):

ship-bump --part 2
ship-bump --part 1
ship-bump --part 0

Decrement instead:

ship-bump --part 2 --unbump

ship-pypi

Build + upload to PyPI:

ship-pypi

Upload to a named repository in ~/.pypirc (e.g. testpypi):

ship-pypi --repository testpypi

Quiet mode:

ship-pypi --quiet

ship-pr

Create a PR from uncommitted or unpushed work, merge it immediately, and clean up:

ship-pr "Add new feature"
ship-pr "Fix bug" --label bug
ship-pr "Breaking change" --label breaking

This command:

  1. Creates a new branch from your current work
  2. Commits any uncommitted changes (using the title as commit message)
  3. Pushes to origin and creates a PR
  4. Adds the specified label (default: enhancement)
  5. Squash-merges the PR
  6. Deletes the remote branch and resets local to updated main

You must be on the default branch (usually main) with no unpulled changes.

ship-changelog

Generate or update CHANGELOG.md from closed GitHub issues since your last release:

ship-changelog

This is useful when you want to edit the changelog separately (e.g., in an editor or Claude Code) before releasing.

ship-release-gh

This is an interactive helper:

  1. Creates/updates CHANGELOG.md from closed GitHub issues since your last GitHub release
  2. Opens your $EDITOR (defaults to nano) so you can edit the changelog
  3. Prompts you to confirm
  4. Runs git commit -am release, git push
  5. Creates a GitHub release tagged with your current __version__
ship-release-gh

If you've already prepared the changelog (e.g., via ship-changelog), skip the changelog step:

ship-release-gh --no-changelog

GitHub token setup

ship-release-gh looks for a token in this order:

  1. FASTSHIP_TOKEN
  2. a ./token file in your repo root
  3. GITHUB_TOKEN

The token must have permission to create releases (typically repo scope for classic PATs, or appropriate fine-grained permissions).

ship-release

Full release workflow assuming changelog is ready:

ship-changelog      # generate changelog, edit as needed
ship-release        # release to GitHub + PyPI, bump version, push

This runs:

  1. ship-release-gh --no_changelog (commit, push, create GitHub release)
  2. ship-pypi (upload to PyPI)
  3. ship-bump (bump patch version)
  4. Commit and push the version bump

Notes

  • ship-pypi does not bump your version for you — keep it explicit and boring.
  • ship-release-gh requires that your project has a git origin remote pointing at GitHub (or use --repo OWNER/REPO).

Existing projects

To add fastship to an existing project:

1) Put your version in __init__.py

In your package's main __init__.py:

__version__ = "0.0.1"

2) Configure pyproject.toml

[project]
name = "my-project"
dynamic = ["version"]

[tool.setuptools.dynamic]
version = { attr = "my_project.__version__" }

Keep __version__ = "x.y.z" as a simple literal (don't compute it). ship-bump will rewrite this line near the top of the file to keep builds happy.

3) Optional: specify branch

Fastship infers your package name from [project].name (changing - to _). To override the release branch:

[tool.fastship]
branch = "main"  # defaults to current git branch

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastship-0.0.7.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastship-0.0.7-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file fastship-0.0.7.tar.gz.

File metadata

  • Download URL: fastship-0.0.7.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for fastship-0.0.7.tar.gz
Algorithm Hash digest
SHA256 623d4e1746579a4bd6d11e7846918b4d33364032af4dce0559da4a8273e163de
MD5 2bd2f1b7182ec66c3d39d5b390b86455
BLAKE2b-256 853e79f62e5b59ca2da21f01a183721e08a89672d453b7fd8ab227ca7aec6adf

See more details on using hashes here.

File details

Details for the file fastship-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: fastship-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for fastship-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b0c4fd8382585e726481ba50f05d5ad8ed174a8570f74dc62c22ee802c9b2541
MD5 35ed7fedff10e2643592766b1fb2edc4
BLAKE2b-256 3d54e1c9283046eb6d5d2a8f55e4dff1940b976eadea11b6eccbeee12a9c88fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page