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

Uploaded Source

Built Distribution

opine-0.6.0-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: opine-0.6.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for opine-0.6.0.tar.gz
Algorithm Hash digest
SHA256 7201b36c4cac8f669c63fc2295b8f4b9a08fa23f663f312b00dff18be95a15a0
MD5 d4a43f111c23fb697d5f9d96c32af2d3
BLAKE2b-256 155b81069ac991fc5aa6a6db36038b348f4cc469e1d956a00436f097579c58c6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: opine-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for opine-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b215024332b9cf57677e1c69c77c3bc57159342ee6c43f485d18b129b4879ce
MD5 2430428eafa784bd4305b3b65f49b88b
BLAKE2b-256 278fb2b2e45aef5018cbffe9c9560b002199c26960c64dc23eae2192981ab531

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