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

Uploaded Source

Built Distribution

shut-0.10.3-py3-none-any.whl (197.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.10.3.tar.gz
  • Upload date:
  • Size: 60.3 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.2 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3

File hashes

Hashes for shut-0.10.3.tar.gz
Algorithm Hash digest
SHA256 fa5eaf94d32b986688fa5aaa33263e16a7b5a08b7f3e51bb3821fe027cff542d
MD5 ccd823bae382bdf0ae0c344d3a2cb37a
BLAKE2b-256 52ae4dfb94679296b7e0da990c16356e6676692e072d767029fd801453ffb0e7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 197.8 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.2 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3

File hashes

Hashes for shut-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 481bc27c5df04573b6741778fd1cc67e190f1f9b4c9b51e9556ae80d5a465fce
MD5 aa55f66063197e939d064effb8978360
BLAKE2b-256 bc4da3150759020837fa8fbfd6106f9bdb8d1d8a116ecefa5bc822afaf8c9ce7

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