The nsupdate.info software Project¶
The initial version of the nsupdate.info software was developed in 48h in the DjangoDash 2013 contest by:
Source code repository, issue tracker (bugs, ideas about enhancements, todo, feedback, …), link to documentation is all there:
Translations are done on Transifex - please collaborate there to avoid double work / workflow issues:
You need the transifex-client package so you have the tx command:
pip install transifex-client
Please make sure to configure your notification settings so that you are notified when the translation project is updated (so you can react quickly and keep your translation fresh).
Translations update workflow (start from a clean workdir):
# pull all translations from transifex:
# update the translations with changes from the source code:
django-admin.py makemessages -a
# compile the translations to .mo files
# push updated translation files back to transifex:
tx push -s -t
Feedback is welcome.
If you find some issue, have some idea or some patch, please submit them via the issue tracker.
Or even better: if you use git, fork our repo, make your changes and submit a pull request.
For small fixes, you can even just edit the files on github (github will then fork, change and submit a pull request automatically).
Install new dependencies¶
See the pipenv docs.
pipenv install mypkg
Spawn a shell with correct python paths¶
Exit the shell with
Update requirements.txt files including transitive dependencies¶
NOTE: This is not done today and only a suggestion.
pipenv requirements --exclude-markers > requirements.d/all.txt
pipenv requirements --exclude-markers --dev-only > requirements.d/dev.txt
Verify the updated dependencies don’t include any security vulnerabilities:
Install build (see its docs for example), e.g. via
pacman -S python-buildon ArchLinux.
Afterwards, run the command to generate pip packages in
NOTE: This is also needed before development because the command generates
pipenv install --dev
src/nsupdate/_version.pyfile by running
Create database using
pipenv run ./manage.py migrate
Create a superuser with
pipenv run ./manage.py createsuperuser
Run the server with
pipenv run ./manage.py runserver
Run pylint in error-only mode to check any problems:
pipenv run pylint src/nsupdate
- NOTE: The project does not use pylint for formatting.
.pylintrcwill show a lot of warnings.
Tests need to run inside Docker because they depend on a
running a specific configuration on
Build the docker image once, using:
docker build -t nsupdate scripts/docker/
Then run tests via
docker run --dns 127.0.0.1 -v $PWD:/app nsupdate