Skip to main content

An opinionated linter for python packaging

Project description

Opine

Most people either hand-write a setup.py, or crib one from someone else. Either way, this usually results in not using the most recent features that can make the job of a distro easier, such as putting the static parts in setup.cfg.

This is a kind of linter for packaging, that can suggest changes to your configuration in {setup.py, setup.cfg, pyproject.toml} for easier consumption by others.

A related project is honesty, whose job it is to make sure that your bdists appear built from the same revision with the same contents as your sdists are.

Usage

opine [-a] /path/to/root

This will run all suggestions and print a sequence of diffs. If you want to apply the changes use -a.

Suggestions

  • Move tox.ini to setup.cfg
  • Move coverage.ini to setup.cfg
  • Move static config from setup.py to setup.cfg

Status

Beta

License

opine is copyright Tim Hatch, and licensed under the MIT license. I am providing code in this repository to you under an open source license. This is my personal repository; the license you receive to my code is from me and not from my employer. See the LICENSE file for details.

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

opine-0.5.1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

opine-0.5.1-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file opine-0.5.1.tar.gz.

File metadata

  • Download URL: opine-0.5.1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.0

File hashes

Hashes for opine-0.5.1.tar.gz
Algorithm Hash digest
SHA256 d78bc23b7503b3eafdcab7f060511ed6e8b07d0fdb7b6d54b6fd629bea851f54
MD5 bb4a0b1e5cf700157279711e771df395
BLAKE2b-256 03993a706aae1ab0cd21209e8da11772922dc434051f087eef22e5967944d492

See more details on using hashes here.

Provenance

File details

Details for the file opine-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: opine-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.0

File hashes

Hashes for opine-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 90b5f14f818c9958bd37313916a05c5cccf741a3613a9cfc238d7432c618d4c0
MD5 f8511d6d57d5fc0c2ec661d45d645c93
BLAKE2b-256 7d2bcb5e92c6eb7a14783ee288a70b6bcbf927642a9e45c4d40852404dfb985e

See more details on using hashes here.

Provenance

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