Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #52

Merged
merged 3 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ check-wip:
python -m pytest tests

serve-api:
MANDR_ROOT=.datamander MANDR_PATH=probabl-ai python -m uvicorn mandr.dashboard.webapp:app --reload --reload-dir ./src --host 0.0.0.0 --timeout-graceful-shutdown 0
MANDR_ROOT=.datamander python -m uvicorn mandr.dashboard.webapp:app --reload --reload-dir ./src --host 0.0.0.0 --timeout-graceful-shutdown 0

build-frontend:
# build the SPA
Expand Down
25 changes: 12 additions & 13 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

```
python -m flask --app mandr.app run --reload
Install dependencies with
```sh
make install
```

## Dependencies
You can run the API server with
```sh
make serve-api
```

When dependencies are changed in `pyproject.toml` the lockfiles should be updated by running [`pip-compile`](https://github.com/jazzband/pip-tools):
When dependencies are changed in `pyproject.toml` the lockfiles should be updated via [`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
```
22 changes: 0 additions & 22 deletions src/mandr/templates/page.html

This file was deleted.

17 changes: 0 additions & 17 deletions src/mandr/templates/partials/artifacts.html

This file was deleted.

53 changes: 0 additions & 53 deletions src/mandr/templates/partials/info.html

This file was deleted.

24 changes: 0 additions & 24 deletions src/mandr/templates/partials/logs.html

This file was deleted.

Empty file.
17 changes: 0 additions & 17 deletions src/mandr/templates/partials/nav-mid.html

This file was deleted.

36 changes: 0 additions & 36 deletions src/mandr/templates/partials/nav-top.html

This file was deleted.

24 changes: 0 additions & 24 deletions src/mandr/templates/partials/views.html

This file was deleted.

46 changes: 0 additions & 46 deletions src/mandr/templates/sketchpad.html

This file was deleted.

Loading