HPI/doc/DEVELOPMENT.org

1.1 KiB

Running tests

I'm using tox to run test/lint. You can check out Github Actions config and /fz0x1/HPI/src/commit/ff84d8fc8825c80445dee052120df7dafdfa0074/scripts/ci/run for the up to date info on the specifics.

IDE setup

To benefit from type hinting, make sure my.config is in your package search path.

In runtime, my.config is imported from the user config directory dynamically.

However, Pycharm/Emacs or whatever IDE you are using won't be able to figure that out, so you'd need to adjust your IDE configuration.

  • Pycharm: basically, follow the instructions here i.e. create a new interpreter configuration (e.g. name it "Python 3.7 (for HPI)"), and add ~/.config/my.

Linting

tox should run all test, mypy, etc.

If you want to run some specific parts/tests, consult /fz0x1/HPI/src/commit/ff84d8fc8825c80445dee052120df7dafdfa0074/doc/tox.ini.

Some useful flags (look them up):

  • -e flag for tox
  • -k flag for pytest