tdsr
Project description
Your short description here.
$ pip install tdsrUsage
Usage instructions t.b.a.
import tdsrDevelopment
If you want to contribute to tdsr, we highly recommend setting up a virtual environment for local development. You can easily do so with pipenv, which can be installed with pip install --user pipenv (instructions) by following the steps below. Note that all commands should be run in the top level directory of the cloned tdsr repository.
$ git clone https://github.com/torstendahm/tdsr.git
$ cd tdsr
$ pipenv install --devWith the virtual environment set up, activate it with pipenv shell. To exit the virtual environment, run exit.
Testing
Tests are located in the /tests directory. To add a new test, add a file with a function name starting with test. To run the full test suite, run:
$ invoke test
$ pytest # can also directly run pytest with custom optionsThis will run tests serially and fail on the first error, which is preferred for local debugging. However, this behaviour can also be changed with invoke test --[no-]fail-fast --parallel.
Code style
tdsr provides automatic code formatting and checks code for conformance.
$ invoke format # format python files
$ invoke lint # lint python files
$ invoke type-check # check for mypy typing errors
$ invoke pre-commit # run all of above checksTo pass CI, ensure that invoke pre-commit passes all checks.
Documentation
Sphinx is used to build the documentation website, which uses reStructuredText (rst). See this website for examples of how to use rst.
To build and preview the documentation locally, you can use
$ invoke docsThis will start a local webserver and open the documentation in the browser for you. If this is not needed, use the --no-serve flag.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
