akshaykmr / hogwatch

[not maintained] find out what's hogging your internet connection.
MIT License
1.23k stars 36 forks source link

packaging suggestions #9

Closed brbsix closed 8 years ago

brbsix commented 8 years ago

Just a few suggestions if you get around to it:

  1. Rename application directory to hogwatch. Otherwise you'll just see an import named application or a directory named application in _${execprefix}/lib/python/site-packages and it's not really clear what package it belongs to.
  2. Add build, hogwatch.egg-info, and MANIFEST to .gitignore. These are part of the build/packaging process and should not be committed or modified.
  3. Delete README.txt or add exclude README.txt to MANIFEST.in (otherwise it will be included in the package).
  4. application/.gitignore and application/server/static/.gitignore don't seem to serve any purpose and should be consolidated into the main .gitignore. If you end up keeping them, exclude them in MANIFEST.in so that they don't get packaged.
akshaykmr commented 8 years ago

2,3 and 4 done. Will address point 1 later since the start script and application folder would have the same name in in the project root. Thanks!

brbsix commented 8 years ago

Cool, great. Also, in case you're interested I just submitted a PR #11 for an easy way to rename the application folder (just move hogwatch script into bin directory).