Add DEVELOPMENT.md to list common development commands

Update `./manage.py` to find application folder in `src/` instead of
expecting a toplevel `nsupdate` folder.
This commit is contained in:
Florian Eitel 2023-01-15 12:47:06 +01:00
parent 7b94ecdf30
commit 5ea29a913b
Signed by: flo
GPG Key ID: 9987EAFEF6F686BB
2 changed files with 15 additions and 0 deletions

12
DEVELOPMENT.md Normal file
View File

@ -0,0 +1,12 @@
# Build locally
1. Install `build` (see [docs](https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives) for example via `pacman -S python-build` on ArchLinux
2. Afterwards run the command to generate pip packgases in `dist/`: `pyproject-build`
NOTE: This is also needed before development because the command generates `./src/nsupdate/_version.py`.
# Run locally
1. Create database using `python ./manage.py migrate`
2. Create a superuser with `python ./manage.py createsuperuser`
2. Run the server with `python ./manage.py runserver`

View File

@ -4,6 +4,9 @@ import sys
if __name__ == "__main__":
PROJECT_ROOT = os.path.dirname(__file__)
sys.path.insert(0, os.path.join(PROJECT_ROOT, 'src'))
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "nsupdate.settings.dev")
from django.core.management import execute_from_command_line
execute_from_command_line(sys.argv)