Skip to content
Snippets Groups Projects
README.md 598 B
Newer Older
Eva Bardou's avatar
Eva Bardou committed
# File Import
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
Worker to import files in various formats in Arkindex
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
## Development
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
For development and tests purpose it may be useful to install the worker as a editable package with pip.
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
```shell
pip3 install -e .
Yoann Schneider's avatar
Yoann Schneider committed
```

Eva Bardou's avatar
Eva Bardou committed
## Linter
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
Code syntax is analyzed before submitting the code.\
To run the linter tools suite you may use pre-commit.
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
```shell
pip install pre-commit
pre-commit run -a
```
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
## Run tests
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
Tests are executed with tox using [pytest](https://pytest.org).
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
```shell
pip install tox
tox
```
Yoann Schneider's avatar
Yoann Schneider committed

Eva Bardou's avatar
Eva Bardou committed
To recreate tox virtual environment (e.g. a dependencies update), you may run `tox -r`