Documentation, for both the library and the import program is generated by rustdoc
from comments. Until it is deployed elsewhere, view it by cloning this repository and run cargo doc --no-deps --open
.
Environment variables should be included in a .env file:
DATA_DIR="data"
DB_USERNAME=DVRPCTC_TEST
DB_PASSWORD='password here'
NOTE: the tests in the db
module require database access, which is limited to white-listed IPs. Therefore, tests are ignored by default. To include them in the test suite, use cargo test -- --include-ignored
.