Skip to main content

A flake8 extension that checks for exact pins (e.q.: `foo==1.5.6`) in setup.py

Project description

Check for exact pins (==) of package requirements in install_requires in setup.py.

For example:

setup(
    # ...
    install_requires=['pyramid==1.5.6'],
    # ...
)

Exact pins are often a bad idea, as they:

  • Limit flexibility if your package is going to be reused; i.e.: used as a library by other Python libraries or applications. You are forcing them to use a particular version that they may not want to use or that conflicts with what they already use. Not so much of an issue if your package is an application rather than a library; however, often requirements.txt is a better place to manage application requirements that you are pinning (see https://caremad.io/blog/setup-vs-requirement/)

  • Bake a very strict requirement into your package; you may have to rebuild your package just to use a new version of a package with a bug fix.

  • Create the potential for hard-to-resolve version conflicts, if you exact pin some package versions and don’t exact pin others. Some of your other packages may require a different version than the one you’re pinning and it might be impossible for pip to resolve this.

Installation

If you don’t already have it, install flake8:

$ pip install flake8

Then, install the extension:

$ pip install flake8-exact-pins

Usage

Run the following to verify that the plugin has been installed correctly:

$ flake8 --version
2.4.1 (pep8: 1.5.7, flake8-exact-pin: 0.0.0, pyflakes: 0.8.1, mccabe: 0.3) CPython 2.7.9 on Darwin

Now, when you run flake8, the plugin will automatically be used.

When an exact pin is found, flake8 will output something like:

./setup.py:28:37: PIN001 exact pin found in install_requires: "pyramid==1.5.6"

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

flake8-exact-pin-0.1.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

flake8_exact_pin-0.1.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file flake8-exact-pin-0.1.0.tar.gz.

File metadata

  • Download URL: flake8-exact-pin-0.1.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for flake8-exact-pin-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e8010174364653b2ecf6d7960b1663fcdd28ef16ec6fc8921b06dc53daa6e5bf
MD5 0ff76fc2331aaf8168d59681a768f447
BLAKE2b-256 be6564af212080d81b49fba3c3f6c8579927b42a95a608e577221760e7ad261e

See more details on using hashes here.

File details

Details for the file flake8_exact_pin-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: flake8_exact_pin-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.5

File hashes

Hashes for flake8_exact_pin-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d876fc6aa69c14c7ffb86b743d64d7d4b503b421bb16c65cca187f2d54bf04fa
MD5 526a3fd41b8409f0990805b205124bed
BLAKE2b-256 94806aa60e374aa8ece274362ada8cc255110dedb762e10544a63caf7f7a4f65

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