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.

Filename, size & hash SHA256 hash help File type Python version Upload date
setuppycheck-0.0.1-py2-none-any.whl (4.3 kB) Copy SHA256 hash SHA256 Wheel 2.7
setuppycheck-0.0.1.tar.gz (2.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page