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

Uploaded Source

Built Distribution

shut-0.17.0-py3-none-any.whl (146.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.17.0.tar.gz
  • Upload date:
  • Size: 72.2 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.0.tar.gz
Algorithm Hash digest
SHA256 4f934eb412d0fa13c9c49d646f6ad1098c11666fa078d5cb1e00fed38f44dd1f
MD5 6a259c6e6d273466c4d9ea631ca42577
BLAKE2b-256 3c99f4c8560daaeff89a195200ac0d5c984c69c262a3719ae2412cc64f16ecd0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 146.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7960f872db3f03a2c67cfd701f2e0dbff00075fa9f58c8c21f50cacfdd2f632
MD5 6738086306548cd893edf39c789f78e4
BLAKE2b-256 b144f8d95c5ace0abee95f8fe47f1b4d0e752b3ac09abce59319e0202ed86c9a

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