Skip to content

Commit

Permalink
added test and build command
Browse files Browse the repository at this point in the history
  • Loading branch information
CaptainDario committed Mar 8, 2021
1 parent 10e2e5e commit d3c74da
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ of every ETL data set entry.
However this package should be easily extendable to add support for accessing the other data.
## Development notes
For development *python 3.9* was used. <br/>

### documentation
The documentation was made with Sphinx and m2r.
m2r is being used to automatically convert this README.md to .rst.
This happens when the ```sphinx-build```-command is invoked in the 'docs'-folder. <br>
Expand All @@ -180,11 +182,27 @@ Build the docs (should be run in docs folder): <br>
sphinx-build source build
```

### packages
A list of all packages needed for development can be found in 'requirements.txt'.

### testing
Some [simple test cases](./tests/test_etldr.py) are defined in the tests folder.
Testing was only performed on Windows 10.<br>
All tests can be executed with:
```
python tests\test_etldr.py
```
Specific tests can be run with:
```
python tests\test_etldr.py etldr.test_read_dataset_part_parallel
```
Those commands should be executed on the top level of this package.

Testing was only performed on Windows 10.
### building the wheel
The wheel can be build with:
```
python setup.py sdist bdist_wheel
```


## Additional Notes
Expand Down

0 comments on commit d3c74da

Please sign in to comment.