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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.10.2.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.2.tar.gz
Algorithm Hash digest
SHA256 8c234a49ebc7f1d1b15487b0cb1ee450ef99ae96b6010f47f97300d38fe69218
MD5 3a941ec913f22b94ed71fdb0a2040bc7
BLAKE2b-256 76f0806c7bb11bb4871e7d66ff0344c430d993c65cb6b280ac8e92669f58b6b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.10.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 19fe22b8d853bd075e7420c86cbda4534ec2aa54af854435d7f9c04531b688e8
MD5 7d090cb2aa46a5d0b1b48308ffad367f
BLAKE2b-256 a2ba1e3ed79a2cd4d8b82e5e25ce1b662eef187fcf29857fd6dab51901bc2259

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