msabramo / setuppycheck

Checks setup.py for questionable practices

setuppycheck: A setup.py checker

Checks for questionable practices in setup.py files.

• PyPI: https://pypi.python.org/pypi/setuppycheck
• GitHub https://github.com/msabramo/setuppycheck

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/

setuppycheck's Issues

Set up tox and Travis CI

Upload to PyPI

Make returning non-zero exit code optional

This would allow using it more easily from a CI system to warn but not break the build.

Add tests

Set up tox

Fixed by 1312a34

Add usage message

Currently it responds with nothing if you run it with no arguments. And --help gives an error:

[marca@marca-mac2 setuppycheck]$ setuppycheck
[marca@marca-mac2 setuppycheck]$ setuppycheck --help
Traceback (most recent call last):
  File "/Users/marca/python/virtualenvs/setuppycheck/bin/setuppycheck", line 9, in <module>
    load_entry_point('setuppycheck==0.0.0', 'console_scripts', 'setuppycheck')()
  File "/Users/marca/dev/git-repos/setuppycheck/setuppycheck.py", line 76, in setuppycheck
    execfile(setuppy, execfile_globals)
IOError: [Errno 2] No such file or directory: '/Users/marca/dev/git-repos/setuppycheck/--help'
[marca@marca-mac2 setuppycheck]$