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.

Requirements

  • Python 3.7+

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
package-data:
  - include: data/*.txt

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.16.1.tar.gz (68.9 kB view details)

Uploaded Source

Built Distribution

shut-0.16.1-py3-none-any.whl (143.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.16.1.tar.gz
  • Upload date:
  • Size: 68.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.10

File hashes

Hashes for shut-0.16.1.tar.gz
Algorithm Hash digest
SHA256 b8075d08023a19876e623444b76434daa54ec90861d6930da30b5af3725a2069
MD5 aba4aba37f7ae9aef6222e572ec24201
BLAKE2b-256 7b29b19bcd5c9b79660d5d3caa97716ecfce18f67456170dfef5c06226184eec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.16.1-py3-none-any.whl
  • Upload date:
  • Size: 143.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.10

File hashes

Hashes for shut-0.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 739a91c3f0e945c76ee9ff6a59df38903c565ec8e48afb4403054f51119ec622
MD5 ca806d0fdbe5c3e1ad83388b69c0c714
BLAKE2b-256 bc7cf3295db94d9e7374f8060cb38d9711a0d498afba367cc826a676e29554d7

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