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

  • Bump version based on changelog
  • Package data / data files
  • Conda recipe generator
  • Automatic check for license headers in files / automatically insert license headers
  • Dev-install packages from mono repositories

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

Uploaded Source

Built Distribution

shut-0.2.0-py3-none-any.whl (155.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shut-0.2.0.tar.gz
  • Upload date:
  • Size: 46.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3

File hashes

Hashes for shut-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0f808bb4bdcec5e52af7a3ff323a1c1b5af3c9fa51521227bc7ffe34b8a538b4
MD5 db2eaf33b94d00b9e6a94bf519e906a1
BLAKE2b-256 7b4a71036fa94497067cbc1f9846104e59272c0f08c7fbc87b474b23c3ddc9fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shut-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 155.9 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/40.8.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.3

File hashes

Hashes for shut-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba8cadeb356118f6eee3e6adeb0823624a7ff65e4c91a99d77c556b2189a76b0
MD5 dbb4909d1d65b8de7e7ad523ac075148
BLAKE2b-256 768eaa36a4b0a3f9e3e2f8815f908f66402ed94e5de0a859a3bc15d1d1d7dcc1

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