Skip to content

accept reformatting #2

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

Merged
merged 1 commit into from
Dec 1, 2023
Merged
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
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# OpenEO FastAPI

A FastAPI implementation of the OpenEO Api specification.

## Use

## Contribute

Included is a vscode dev container which is intended to be used as the development environment for this package. A virtual environment needs to be set up inside the dev container, this is managed by poetry.

#### Setup

1. In VSCode `Ctrl + shift + p` and select "Dev Containers: Rebuild Container" to open the development environment for the first time.

2. Once the development environment is ready, run the following commands.
```
# Working from /openeo-fastapi

poetry lock

poetry install --all-extras

poetry run pre-commit install
```

If you want to add a new dependency. Add it to the pyproject.toml and rerun the two commands again.

Git is available in the container, so you can commit and push directy to your development branch.

3. You are now ready to write code and run tests!

Either
```
poetry run python -m pytest
```

Or, run them directly from the testing section of vscode.