Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
augustebaum committed Jul 17, 2024
1 parent f7701e3 commit 35b567e
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@

![lint and test](https://github.com/probabl-ai/mandr/actions/workflows/lint-and-test.yml/badge.svg)

Service to send data into, install via

```
python -m pip install -e
python -m pip install flask diskcache pandas altair
```
A service to send data into.

## Example

```python
from mandr import InfoMander
Expand All @@ -21,16 +17,19 @@ mander.add_templates(...)
mander.add_views(...)
```

When ready to view, run flask:
## Development

Install dependencies with
```sh
make install
```

When ready to view, run flask:
```sh
python -m flask --app mandr.app run --reload
```

## Dependencies

When dependencies are changed in `pyproject.toml` the lockfiles should be updated by running [`pip-compile`](https://github.com/jazzband/pip-tools):
```sh
pip-compile --output-file=requirements.txt pyproject.toml
pip-compile --extra=test --output-file=requirements-test.txt pyproject.toml
make pip-compile
```

0 comments on commit 35b567e

Please sign in to comment.