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

Uploaded Source

Built Distribution

shut-0.16.0-py3-none-any.whl (143.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.16.0.tar.gz
  • Upload date:
  • Size: 68.7 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.5

File hashes

Hashes for shut-0.16.0.tar.gz
Algorithm Hash digest
SHA256 4519bc8db17e4c2d0b0547ad608e6b335c2af44a28ecdf9358d5235f76e3dd1f
MD5 e4d19dac998c35738db3008c98342f1d
BLAKE2b-256 b898cfca7ccd5229885ee5ce93a5ff4acfdfff6db0f4b9fcbbc734e5a67cf82c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.16.0-py3-none-any.whl
  • Upload date:
  • Size: 143.3 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.5

File hashes

Hashes for shut-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b89d4008ade8865e3d1a911ea9a1d8e469f2b731887bca56bd61090a76572629
MD5 292e48e3d4dfef8546aa9b13337ef1f8
BLAKE2b-256 badc1b6c994a9396240ebb3e6c39adfa7d3c9493157917787f766b317f97af34

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