diff --git a/README.md b/README.md new file mode 100755 index 0000000..cd260be --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +[![Release](https://img.shields.io/github/v/release/opengisch/qgis-pg-service-parser-plugin.svg)](https://github.com/opengisch/qgis-pg-service-parser-plugin/releases) + +# PG service parser plugin + +Logo + + +QGIS v3 plugin to view, edit or copy PG service (i.e., `pg_service.conf`) entries for PostgreSQL connections. + +This plugin is distributed under the [GNU GPL v3 license](https://github.com/opengisch/qgis-pg-service-parser-plugin/blob/main/LICENSE). + + + +### pg_service.conf location + +If your `pg_service.conf` file is located at `/home/YOUR_USER/.pg_service.conf` (on Linux) or at `%APPDATA%\postgresql\.pg_service.conf` (on Windows), then you are done! The plugin will read your file directly. + +If that's not the case, i.e., if your `pg_service.conf` file is not in the aforementioned locations, you can still set the `PGSERVICEFILE` environment variable pointing to your `pg_service.conf` file path before using the plugin. + + + +### Edit PG service entries + +Edit service + + + +### Copy PG service entries + +Copy service + + + +### For devs + +#### pgserviceparser library + +This plugin uses the [pgserviceparser](https://github.com/opengisch/pgserviceparser) library. It's also available as a [PYPI package](https://pypi.org/project/pgserviceparser/). + + + +#### Code style + +Use pre-commit: + +``` +pip install pre-commit +pre-commit install +``` diff --git a/images/copy_service.png b/images/copy_service.png new file mode 100644 index 0000000..d804ffc Binary files /dev/null and b/images/copy_service.png differ diff --git a/images/edit_service.png b/images/edit_service.png new file mode 100644 index 0000000..66c3c12 Binary files /dev/null and b/images/edit_service.png differ