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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.7.1.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.1.tar.gz
Algorithm Hash digest
SHA256 0a04f2801382412d3afed46514166fa1e7aa0ee0b6fe2f7226ca5857db409458
MD5 2b766fef45818e060af546373022f683
BLAKE2b-256 1fd1492b8c07e3a247d8ba8e7fdfe6040a17e7559d9bd8021a8ca76ba551c5d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.7.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2d29328d4014f5ddfeb79ea8e00ae31ea0e2f965d59a0832803d341b5ae38ed
MD5 0b81856c29edee50ab1503cc4bdce3d5
BLAKE2b-256 44588ce2f312aebb80b767a30c6314123780529602fd6aec5cf83ab3fdee412f

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