Skip to main content

Automates the heavy lifting of release and distribution management for pure Python packages.

Project description

shut

Shut is an opinionated tool that allows you to configure everything around the Python packaging and release process from a single source of truth. It is intended to simplify the process of publishing Python packages and prevent common pitfalls.

At a glance

  • Bootstrap Python packages: shut pkg new --name my-package
  • Install and save dependencies: shut pkg requirements add <package>
  • Document changes: shut changelog --add fix --commit --message "Fixed `TypeError` in `foo()`"
  • Bump the version according to changelog: shut pkg bump --minor --tag --push
  • Publish on PyPI: shut pkg publish warehouse:pypi

Configuration

package.yml

name: my-package
modulename: my_module
version: 0.1.0
license: MIT
description: My first every package built with Shut
author: Me <me@example.org>
requirements:
- python ^3.5
- requests ^2.22.0
entrypoints:
  console_scripts:
  - mycli = my_module.__main__:mycli

Todo

  • Package data / data files
  • Conda recipe generator
  • Automatic check for license headers in files / automatically insert license headers

Copyright © 2020, Niklas Rosenstein

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

shut-0.8.0.tar.gz (61.4 kB view details)

Uploaded Source

Built Distribution

shut-0.8.0-py3-none-any.whl (130.2 kB view details)

Uploaded Python 3

File details

Details for the file shut-0.8.0.tar.gz.

File metadata

  • Download URL: shut-0.8.0.tar.gz
  • Upload date:
  • Size: 61.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for shut-0.8.0.tar.gz
Algorithm Hash digest
SHA256 a262006f2eeeb8af40bc7838a6b1c29f829df267e4ad1518a985cd8f61983cf7
MD5 104c6e1a94517dc4328a6c50723a7b1d
BLAKE2b-256 4f25c0e557d6bf73658ab592c4bdea9ad8405f0152d6e1d371e14cb8302456c4

See more details on using hashes here.

File details

Details for the file shut-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: shut-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 130.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for shut-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4f2f9d3047cb4de4942c5106218be72c74329b9f75aa8354618fe51f53081a11
MD5 9e8ca780a33fa3fc235a3cf5075d2221
BLAKE2b-256 f74cfe7ffede49afa365f447686862cfaf5435e5c134f5f97d58c1ca5c7cc8e1

See more details on using hashes here.

Supported by

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