Documentation: Development environment

[dennissiemensma]

The documentation should have a section describing how to set up a development evironment, running and testing it.

• System packages
• PIP
• DB import + settings reset
• Runserver
• Incoming API (dsmr_datalogger_api_client.py)
• Running tests
• Coverage
• PO edit

[dennissiemensma]

pip3 install -r dsmrreader/provisioning/requirements/base.txt -r dsmrreader/provisioning/requirements/dev.txt -r dsmrreader/provisioning/requirements/test.txt -r dsmrreader/provisioning/requirements/postgresql.txt -r dsmrreader/provisioning/requirements/mysql.txt -r dsmrreader/provisioning/requirements/travis.txt

[ttencate]

Was just looking for this. Got ./manage.py runserver to serve something on localhost:8000, but it's missing all the JS and CSS because these are designed to be served directly by nginx. Any quick pointers would be much appreciated!

Edit: Ah, I just needed to change dsmrreader/settings.py to import development instead of production :)

[dennissiemensma]

Correct.

En wat betreft testdata, het makkelijkste is om een database van productie in te lezen en die 'dood' te maken qua externe koppelingen. Je kunt dat eenvoudig realiseren met het volgende management command die ik ervoor gemaakt heb:

• ./manage.py development_reset

Dit:

• Reset de meeste externe koppelingen (ik zie dat ik MQTT vergeten ben overigens)
• Reset de admin-user qua credentials naar admin / admin om mee in te loggen

[dennissiemensma]

Als je overigens wilt testen met live data die constant binnenstroomt, kun je het beste je productieomgeving wisselen naar een API-pusher, die zowel lokaal (op productie zelf) als naar je testomgeving/PC callt.

Dat kan met de v1 API scripts uit de docs (http://dsmr-reader.readthedocs.io/nl/latest/api.html#script). Je kunt dan meerdere endpoints configureren, ik heb bijvoorbeeld:

API_SERVERS = (
    # You can add multiple hosts here... just copy the line below and paste it directly under it.
    ('http://localhost/api/v1/datalogger/dsmrreading', '**************************'),
    ('http://pc-hostname-of-ip:8000/api/v1/datalogger/dsmrreading', 'test'),
)

Let wel op dat de development_reset de API token van de testomgeving reset naar test.

[dennissiemensma]

Ik laat dit voor wat het is voor nu. Wellicht dat ik het weer helemaal uitwerk op het moment dat ik thuis een herinstallatie van mn ontwikkelomgeving nodig heb.

[dennissiemensma]

De herinstallatie is daar, dus mooi moment.

[dennissiemensma]

Done, voor volgende release: https://dsmr-reader.readthedocs.io/nl/development/development.html

[dennissiemensma]

Nog een kleine toevoeging gedaan m.b.t. coverage hulp.