agdsn / pycroft

The AG DSN management system
Apache License 2.0
21 stars 9 forks source link

Setup script #521

Open lukasjuhrich opened 2 years ago

lukasjuhrich commented 2 years ago

Immediate concerns

There are multiple things one needs to keep track of / initially set up with regards to our current setup:

We should find a way to automate this or at least bundle these things in a script like scripts/setup.py. Perhaps a Makefile-based approach delegating to such scripts would be sufficient.

Other benefits

  1. Another useful thing one could add would be a make docs which builds the docs and/or sets up things like sphinx-autobuild. In doing so, we could move lots of documentation in the Readme.md to the sphinx docs, and in turn make the Readme.md more to-the-point regarding the initial development setup

  2. We could automate copyright-bumps and/or version bumps

Does anybody have strong opinions about how to approach this?

lukasjuhrich commented 2 years ago

@strebbin if you have time this would be extremely helpful. Especially because the pitfalls in the db-setup you would be encountering with a clean setup would be nice to know & could be incorporated in such a setup script.

I admit it's not particularly challenging or interesting tho.