Skip to content
Open
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
8 changes: 5 additions & 3 deletions docs/content/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ docker compose exec django python manage.py migrate --no-input
docker compose exec django python manage.py populate_users
docker compose exec django python manage.py populate_data
```

After waiting little you'll be able to access all collections at http://0.0.0.0:7180/oapif/collections.

Three users are provided out of the box; they can be logged in with through basic authentication; all `123` for password:

- `demo_viewer`
- `demo_editor`
- `admin`
Expand All @@ -40,7 +42,7 @@ When up and running you can access the REST API from QGIS like this:

- Go to `Layers` > `Add layer` > `Add WFS Layer...`
- Create a new connection
- URL: `https://0.0.0.0:7180/oapif/`
- Version: `OGC API - Features`
- URL: `https://0.0.0.0:7180/oapif/`
- Version: `OGC API - Features`
- Click OK and ignore choose to ignore the invalid certificate error and store the exception
- You should see the two layers in the list, select them and choose `add`.
- You should see the two layers in the list, select them and choose `Add`.
4 changes: 3 additions & 1 deletion docs/content/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pip install --user https://github.com/opengisch/django-oapif

Edit settings.py

```
```python
INSTALLED_APPS = [
...
"django_oapif",
Expand All @@ -28,11 +28,13 @@ INSTALLED_APPS = [

Add this to your `urls.py` :

```python
urlpatterns += [
...,
path("oapif/", include(django_oapif.urls)),
...,
]
```

## Register your models with the decorator:

Expand Down
17 changes: 9 additions & 8 deletions docs/content/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,25 @@ hide:

## Run tests

# unit tests
docker compose exec django python manage.py test

# integration tests
docker compose --profile testing_integration up -d
docker compose run integration_tests
```bash
# unit tests
docker compose exec django python manage.py test

# integration tests
docker compose --profile testing_integration up -d
docker compose run integration_tests
```

## OGC Conformance

You can run the OGC API conformance test suite like this:

```
```bash
docker compose --profile testing_conformance up --build -d
docker compose exec django python manage.py migrate --no-input
docker compose exec django python manage.py populate_users
docker compose exec django python manage.py populate_data
docker compose run conformance_test
```

Results will be stored to `tests/output/emailable-report.html
Results will be stored to `tests/output/emailable-report.html`