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

Uploaded Source

Built Distribution

shut-0.17.1-py3-none-any.whl (146.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.17.1.tar.gz
  • Upload date:
  • Size: 72.3 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.61.2 CPython/3.9.6

File hashes

Hashes for shut-0.17.1.tar.gz
Algorithm Hash digest
SHA256 8aab856b2d279f2dc5c467f4730e86706feefdd022e213fb78f12fec15e8ca12
MD5 f7f5836c0cb5b48b51517dbb2a20b175
BLAKE2b-256 3d0760808f89c439b29c1813c1b8874f9962db161ca0e4f0f9e4093fb335d7a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.17.1-py3-none-any.whl
  • Upload date:
  • Size: 146.9 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.61.2 CPython/3.9.6

File hashes

Hashes for shut-0.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 61b157d2097ca8f2829b050bd777308bffab970ff4aebf3b84f2391205c83ccf
MD5 91dd94a324bd4d89ec81c5fe178e0a7c
BLAKE2b-256 f9aaafcc70d09b284887c6dfa21da67d659aeba7aeac58e465332602baa60240

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