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

Uploaded Source

Built Distribution

shut-0.10.1-py3-none-any.whl (197.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.10.1.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.1.tar.gz
Algorithm Hash digest
SHA256 eee67fc8a2b646943a9d5c8dcd3f3fcc7e6346737e277d14f8f138536bff15c3
MD5 f35a5057c64b5a040d69ca1608933e78
BLAKE2b-256 78ae8f255e4332f01743d8715a05bd04b52a5040f91adf4514a9afad282640a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 197.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f188f416d00bb4a7e586e6a4940e06c07842e6e2f39a0f9ed8359daf0f7e7374
MD5 6b822f25ea1b90611a89869b644fbbab
BLAKE2b-256 22160ea6b9d12613c2f4bb390dfb388318b57b294b2dfc86825820b16c77f4c3

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