Skip to content
Snippets Groups Projects
README.md 599 B
Newer Older
Bastien Abadie's avatar
Bastien Abadie committed
# Init Elements

Eva Bardou's avatar
Eva Bardou committed
Worker to initialize Arkindex elements to process
Bastien Abadie's avatar
Bastien Abadie committed

Eva Bardou's avatar
Eva Bardou committed
### Development
Bastien Abadie's avatar
Bastien Abadie 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.
Bastien Abadie's avatar
Bastien Abadie committed

Eva Bardou's avatar
Eva Bardou committed
```shell
pip3 install -e .
Bastien Abadie's avatar
Bastien Abadie committed
```

Eva Bardou's avatar
Eva Bardou committed
### Linter
Bastien Abadie's avatar
Bastien Abadie 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.
Bastien Abadie's avatar
Bastien Abadie committed

Eva Bardou's avatar
Eva Bardou committed
```shell
pip install pre-commit
pre-commit run -a
```
Bastien Abadie's avatar
Bastien Abadie committed

Eva Bardou's avatar
Eva Bardou committed
### Run tests
Bastien Abadie's avatar
Bastien Abadie committed

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

Eva Bardou's avatar
Eva Bardou committed
```shell
pip install tox
tox
```
Bastien Abadie's avatar
Bastien Abadie committed

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