Skip to main content

Checks for questionable practices in setup.py files.

Project description

https://travis-ci.org/msabramo/setuppycheck.svg?branch=master https://img.shields.io/pypi/v/setuppycheck.svg https://img.shields.io/pypi/wheel/setuppycheck.svg

Checks for questionable practices in setup.py files.

Install

$ pip install setuppycheck

Use

[marca@marca-mac2 setuppycheck]$ setuppycheck examples/exact_pins/setup.py
WARNING: exact pin: 'requests==2.7.0'
[marca@marca-mac2 setuppycheck]$ echo $?
1

[marca@marca-mac2 setuppycheck]$ setuppycheck examples/reads_requirements_text/setup.py
WARNING: reads '/Users/marca/dev/git-repos/setuppycheck/examples/reads_requirements_text/requirements.txt' - looks like a requirements file?
  You might want to look at https://caremad.io/2013/07/setup-vs-requirement/
[marca@marca-mac2 setuppycheck]$ echo $?
1

Checks

  • Checks that you are not using exact pins in your setup.py file – Exact pins in setup.py get baked into the packages you build and limit flexibility. Folks using your package will have to have that same exact version. If you want to update it, you have to build a new package.

  • Checks that you are not reading a requirements.txt file and using it to populate install_requires in setup.py. I think that people mostly do this because they don’t understand the differences between setup.py and requirements.txt so I would advise reading https://caremad.io/2013/07/setup-vs-requirement/

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

setuppycheck-0.0.1.tar.gz (2.4 kB view details)

Uploaded Source

Built Distribution

setuppycheck-0.0.1-py2-none-any.whl (4.3 kB view details)

Uploaded Python 2

File details

Details for the file setuppycheck-0.0.1.tar.gz.

File metadata

File hashes

Hashes for setuppycheck-0.0.1.tar.gz
Algorithm Hash digest
SHA256 74c3c91aebde8fdfacd6f128f3901f8342b398fc7190b0c5934daeebe03d6ecf
MD5 46f5787a7971e4094ca9965b6147a705
BLAKE2b-256 f241f8c356aa9a81a73d6260bd5441469ce9786d8b35b7e0aceaedab0d8cbe55

See more details on using hashes here.

File details

Details for the file setuppycheck-0.0.1-py2-none-any.whl.

File metadata

File hashes

Hashes for setuppycheck-0.0.1-py2-none-any.whl
Algorithm Hash digest
SHA256 603e54f45b59a0ce7b1f6c4e19c421b1f55573ad99f472336299f26a535ed963
MD5 2347f9bbe8a76a53546c374b4d74a222
BLAKE2b-256 05e3c51718b4b58f162ec44258e9ea893c376e1b472ca9d7d2de52647f135a5b

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