setup.py 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. #!/usr/bin/env python3.5
  2. # Copyright 2017 Digital
  3. #
  4. # This file is part of BeeWatch.
  5. #
  6. # BeeWatch is free software: you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation, either version 3 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # BeeWatch is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with BeeWatch. If not, see <http://www.gnu.org/licenses/>.
  18. """
  19. Installation Guide for BeeWatch
  20. ===============================
  21. .. Warning:
  22. This program only supports GNU/Linux distros. It may work under another platform but I doubt that.
  23. You can install the module, build the documentation or do both (advised ;P). If you install the module after you have built the documentation, the documentation is copied to the folder of the installed module.
  24. Install BeeWatch
  25. ================
  26. To install BeeWatch run `./setup.py install` in BeeWatch-X.X. For more options run `./setup.py help` or see `Distributing on python.org <https://docs.python.org/3/distutils/index.html>`_
  27. Build the documentation
  28. =======================
  29. This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run ``make help`` to get a list of supported file formats. Let's say you chose html, so you run ``make html``. This create the documentation in `docs/html`. The entry point is `docs/html/index.html`.
  30. """
  31. from distutils.core import setup
  32. setup_kwargs = {
  33. 'name':'BeeWatch',
  34. 'version': '0.0',
  35. 'description':'Beehive analyzer',
  36. 'author':'Digital',
  37. 'author_email':'[email protected]',
  38. 'url':'https://beewatch.readthedocs.io',
  39. 'packages':[
  40. 'beewatch',
  41. 'beewatch.gui',
  42. 'beewatch.pinapi',
  43. 'beewatch.server',
  44. ],
  45. }
  46. setup(**setup_kwargs)
  47. #