Skip to content

Commit 7edc511

Browse files
committed
- updated README and metadata.txt
1 parent 71d0905 commit 7edc511

3 files changed

Lines changed: 31 additions & 7 deletions

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1+
![icon](/icon.png)
12
# pygeoapi configurator
23

3-
This plugin lets you read and write a [pygeoapi](https://pygeoapi.io/) configuration file on your local machine.
4+
This plugin lets you read and write a [pygeoapi](https://pygeoapi.io/) configuration file on your local machine. You can deploy this configuration, by uploading it to a server with a pygeoapi instance.
5+
6+
In alternative you can pull and push a configuration directly from/to a running pygeoapi instance. In order to to this:
7+
8+
* The pygeoapi [admin API](https://docs.pygeoapi.io/en/latest/admin-api.html) must be enabled on that instance.
9+
* The pygeoapi instance must be *unprotected* (*i.e.*: without authentication enabled).
10+
* If you want to see the changes without restarting the service, you must [run pygeoapi with hot reload](https://docs.pygeoapi.io/en/latest/admin-api.html#pygeoapi-hot-reloading-in-gunicorn).
11+
12+
It goes without saying that a combination of an unprotected instance and an enabled admin API creates a security risk that is unaceptable for production scenarios. For that reason it should be used for **testing purposes only, without exposing the service to the Internet**.
13+
14+
Run pygeoapi docker container with hot reload, mounting a local configuration file:
15+
16+
```bash
17+
docker run -p 5000:80 -v $(pwd)/example-config.yml:/pygeoapi/local.config.yml geopython/pygeoapi:latest run-with-hot-reload
18+
```
419

520
## Deploy
621

@@ -42,6 +57,15 @@ Modify the user interface by opening pygeoapiconfig_dialog_base.ui in [Qt Creato
4257

4358
`lrelease pygeoapi_config_pt.ts`
4459

60+
## Contributing 🤝
61+
62+
This plugin is a live project and we welcome contributions from the community! If you have suggestions for improvements, found a bug, or want to add new features, feel free to:
63+
64+
* Open an [issue](https://github.com/opengeospatial/ogc-records-website/issues) to start a discussion
65+
* Submit a [pull request](https://github.com/opengeospatial/ogc-records-website/pulls) with your proposed changes
66+
67+
We appreciate your support in making this plugin better!
68+
4569
## License
4670

4771
This project is released under an [MIT License](./LICENSE)

metadata.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
[general]
66
name=pygeoapi configurator
77
qgisMinimumVersion=3.0
8-
description=Update pygeoapi configuration file
8+
description=Read and write a pygeoapi configuration
99
version=0.1
1010
author=ByteRoad
1111
email=info@byteroad.net
1212

13-
about=This plugin lets you create a pygeoapi configuration file.
13+
about=This plugin lets you read and write a pygeoapi configuration file that you can later upload to a server. You can also pull and push a configuration directly from an (unprotected) server.
1414

15-
tracker=http://bugs
16-
repository=http://repo
15+
tracker=https://github.com/byteroad/pygeoapi_config/issues
16+
repository=https://github.com/byteroad/pygeoapi_config/
1717
# End of mandatory metadata
1818

1919
# Recommended items:
@@ -23,9 +23,9 @@ hasProcessingProvider=no
2323
# changelog=
2424

2525
# Tags are comma separated with spaces allowed
26-
tags=python
26+
tags=pygeoapi
2727

28-
homepage=http://homepage
28+
homepage=https://github.com/byteroad/pygeoapi_config/blob/master/README.md
2929
category=Plugins
3030
icon=icon.png
3131
# experimental flag

screenshot.png

48.5 KB
Loading

0 commit comments

Comments
 (0)