-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add running instructions to readme
- Loading branch information
1 parent
27d2c03
commit c44b4ba
Showing
1 changed file
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,39 @@ | ||
# OC4IDS Datastore Pipeline | ||
|
||
## Run linting | ||
A Python application to validate and store published OC4IDS datasets. | ||
|
||
## Local Development | ||
|
||
### Prerequisites | ||
|
||
- Python 3.12 | ||
|
||
### Install Python requirements | ||
|
||
``` | ||
python -m venv .venv | ||
source .venv/bin/activate | ||
pip install -r requirements_dev.txt | ||
``` | ||
|
||
### Run app | ||
|
||
``` | ||
pip install -e . | ||
oc4ids-datastore-pipeline | ||
``` | ||
|
||
### Run linting and type checking | ||
|
||
``` | ||
black oc4ids_datastore_pipeline/ | ||
isort oc4ids_datastore_pipeline/ | ||
flake8 oc4ids_datastore_pipeline/ | ||
mypy oc4ids_datastore_pipeline/ | ||
``` | ||
|
||
### Run tests | ||
|
||
``` | ||
pytest | ||
``` |