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

Uploaded Source

Built Distribution

shut-0.7.2-py3-none-any.whl (130.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.7.2.tar.gz
  • Upload date:
  • Size: 58.1 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.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for shut-0.7.2.tar.gz
Algorithm Hash digest
SHA256 2929c789cba59b1b44f0d99343aa7fd1b808058cc3f5cd4732a9f4e6a61cb475
MD5 b70fd9ddea5ade434e148402a62ddaa9
BLAKE2b-256 1c6eab3ba0503b6fbf799faf6657421b50c1c8e4728a8c250bd684ff49eb412f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 130.0 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.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for shut-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 05df5052889b729fb46462f8d8e4aacd14655e09916ca71f1486b8d7377d137d
MD5 dba4b312a0b56d7838bf8848e45d60c1
BLAKE2b-256 1fb38ccd33f8e951121f32d2e19d88c303d20be08053a243d931ddf2f49fd848

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