# pygeoapi-plugins
pygeoapi plugins developed by the Center for Geospatial Solutions
## OGC API - Features
Additional OGC API - Feature providers are listed below, along with a matrix of supported query parameters.
| Provider | Property Filters/Display | Result Type | BBox | Datetime | Sort By | Skip Geometry | CQL | Transactions | CRS |
| ------------------ | ------------------------ | ------------ | ---- | -------- | ------- | ------------- | --- | ------------ | --- |
| `CKAN` | ✅/✅ | results/hits | ❌ | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ |
| `PsuedoPostgreSQL` | ✅/✅ | results/hits | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
| `SPARQL` | ❌/✅ | results/hits | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
The provider names listed in the table are only accessible in [internetofwater/pygeoapi](https://github.com/internetofwater/pygeoapi), otherwise the full python path is required.
### CKAN
The CKAN Provider enables OGC API - Feature support at the collection level for a specific resource within the datastore-search endpoints of CKAN instances.
It allows you to integrate CKAN resources into your pygeoapi instance.
The provider definition for the CKAN Provider includes configuration options specific to CKAN.
To use the CKAN Provider, you need to specify `pygeoapi_plugins.provider.ckan.CKANProvider` as the provider's name.
```
providers:
- type: feature
name: pygeoapi_plugins.provider.ckan.CKANProvider
data: https://catalog.newmexicowaterdata.org/api/3/action/datastore_search
resource_id: 08369d21-520b-439e-97e3-5ecb50737887
id_field: _id
x_field: LONDD
y_field: LATDD
```
In this example, the CKAN Provider is configured to work with the specified CKAN resource.
- `data`: The URL endpoint for the datastore search API of the CKAN instance.
- `resource_id`: The identifier of the specific CKAN resource you want to access within the datastore.
- `id_field`: The field that serves as the unique identifier for features in the CKAN resource.
- `x_field`: The field representing the X-coordinate (longitude) for the features in the CKAN resource.
- `y_field`: The field representing the Y-coordinate (latitude) for the features in the CKAN resource.
### PseudoPostgresSQL
The PseudoPostgresSQL Provider adds a simple capacity to the PostgresSQL Provider in pygeoapi core - faster counting.
This is done by performing a pseudo-count on tables exceeding a definable limit.
The limit is defined using the PSEUDO_COUNT_LIMIT environment variable.
To use the PseudoPostgresSQL Provider, you need to specify `pygeoapi_plugins.provider.postgresql.PseudoPostgreSQLProvider` as the provider's name.
### SPARQL
The SPARQL Provider is a wrapper for any pygeoapi feature provider that provides additional context, allowing integration of SPARQL-based data sources into a pygeoapi instance.
By wrapping another feature provider, the SPARQL Provider inherits queryable capacities from the wrapped feature provider - adding SPARQL context to each resulting feature.
The provider definition for the SPARQL Provider is similar to that of the wrapped provider, with the addition of specific SPARQL-related configuration options.
To use the SPARQL Provider, you need to specify `pygeoapi_plugins.provider.sparql.SPARQLProvider` as the provider's name.
```
providers:
- type: feature
name: pygeoapi_plugins.provider.sparql.SPARQLProvider
data: /pygeoapi_plugins/tests/data/ne_110m_populated_places_simple.geojson
id_field: id
sparql_provider: GeoJSON
sparql_endpoint: https://dbpedia.org/sparql
sparql_subject: uri
sparql_predicates:
leader: dbpedia2:leaderName|dbp:leaderName
population: dbo:populationTotal|dbp:populationCensus
```
In this example, the SPARQL Provider wraps the GeoJSON Provider.
The SPARQL Provider only uses variables prefixed with sparql\_ in the configuration.
- `data`: The path to the data file used by the wrapped provider (GeoJSON Provider in this case).
- `id_field`: The field that serves as the unique identifier for features in the data.
- `sparql_provider`: The name of the provider that will handle the SPARQL query results (GeoJSON Provider in this case).
- `sparql_endpoint`: The SPARQL endpoint URL to query for data.
- `sparql_subject`: The SPARQL variable representing the subject URI in the query.
- `sparql_predicates`: A mapping of attribute names to SPARQL predicates. These predicates will be used to query specific attributes in the SPARQL data source.
## OGC API - Processes
Additional OGC API - Process are listed below
### Intersector
The intersection process uses OGC API - Features Part 3: Filtering to return CQL intersections of features.
An example configuration in a pygeoapi configuration is below.
```
intersector:
type: process
processor:
name: pygeoapi_plugins.process.intersect.IntersectionProcessor
```
This plugin is used in https:/reference.geoconnex.us/.
### Sitemap Generator
The Sitemap Generator process makes use of the XML formatter and OGC API - Features to generate a sitemap of the pygeoapi instance.
This can be used with the python package [sitemap-generator](https://github.com/cgs-earth/sitemap-generator) to generate a sitemap index.
An example configuration in a pygeoapi configuration is below.
```
sitemap-generator:
type: process
processor:
name: pygeoapi_plugins.process.sitemap.SitemapProcessor
```
Raw data
{
"_id": null,
"home_page": "https://github.com/cgs-earth/pygeoapi-plugins",
"name": "pygeoapi-plugins",
"maintainer": "Benjamin Webb",
"docs_url": null,
"requires_python": null,
"maintainer_email": "bwebb@lincolninst.edu",
"keywords": "cgs pygeoapi geopython",
"author": "Benjamin Webb",
"author_email": "bwebb@lincolninst.edu",
"download_url": "https://files.pythonhosted.org/packages/81/ca/513b1d2b6b7a8a7cdc50ec65df59c5a403ee824826e5414ca2c005fe0d82/pygeoapi_plugins-0.1.0.tar.gz",
"platform": "all",
"description": "# pygeoapi-plugins\n\npygeoapi plugins developed by the Center for Geospatial Solutions\n\n## OGC API - Features\n\nAdditional OGC API - Feature providers are listed below, along with a matrix of supported query parameters.\n\n| Provider | Property Filters/Display | Result Type | BBox | Datetime | Sort By | Skip Geometry | CQL | Transactions | CRS |\n| ------------------ | ------------------------ | ------------ | ---- | -------- | ------- | ------------- | --- | ------------ | --- |\n| `CKAN` | \u2705/\u2705 | results/hits | \u274c | \u274c | \u2705 | \u2705 | \u274c | \u274c | \u2705 |\n| `PsuedoPostgreSQL` | \u2705/\u2705 | results/hits | \u2705 | \u2705 | \u2705 | \u2705 | \u2705 | \u274c | \u2705 |\n| `SPARQL` | \u274c/\u2705 | results/hits | \u274c | \u274c | \u274c | \u274c | \u274c | \u274c | \u274c |\n\nThe provider names listed in the table are only accessible in [internetofwater/pygeoapi](https://github.com/internetofwater/pygeoapi), otherwise the full python path is required.\n\n### CKAN\n\nThe CKAN Provider enables OGC API - Feature support at the collection level for a specific resource within the datastore-search endpoints of CKAN instances.\nIt allows you to integrate CKAN resources into your pygeoapi instance.\nThe provider definition for the CKAN Provider includes configuration options specific to CKAN.\nTo use the CKAN Provider, you need to specify `pygeoapi_plugins.provider.ckan.CKANProvider` as the provider's name.\n\n```\n providers:\n - type: feature\n name: pygeoapi_plugins.provider.ckan.CKANProvider\n data: https://catalog.newmexicowaterdata.org/api/3/action/datastore_search\n resource_id: 08369d21-520b-439e-97e3-5ecb50737887\n id_field: _id\n x_field: LONDD\n y_field: LATDD\n```\n\nIn this example, the CKAN Provider is configured to work with the specified CKAN resource.\n\n- `data`: The URL endpoint for the datastore search API of the CKAN instance.\n- `resource_id`: The identifier of the specific CKAN resource you want to access within the datastore.\n- `id_field`: The field that serves as the unique identifier for features in the CKAN resource.\n- `x_field`: The field representing the X-coordinate (longitude) for the features in the CKAN resource.\n- `y_field`: The field representing the Y-coordinate (latitude) for the features in the CKAN resource.\n\n### PseudoPostgresSQL\n\nThe PseudoPostgresSQL Provider adds a simple capacity to the PostgresSQL Provider in pygeoapi core - faster counting.\nThis is done by performing a pseudo-count on tables exceeding a definable limit.\nThe limit is defined using the PSEUDO_COUNT_LIMIT environment variable.\nTo use the PseudoPostgresSQL Provider, you need to specify `pygeoapi_plugins.provider.postgresql.PseudoPostgreSQLProvider` as the provider's name.\n\n### SPARQL\n\nThe SPARQL Provider is a wrapper for any pygeoapi feature provider that provides additional context, allowing integration of SPARQL-based data sources into a pygeoapi instance.\nBy wrapping another feature provider, the SPARQL Provider inherits queryable capacities from the wrapped feature provider - adding SPARQL context to each resulting feature.\nThe provider definition for the SPARQL Provider is similar to that of the wrapped provider, with the addition of specific SPARQL-related configuration options.\nTo use the SPARQL Provider, you need to specify `pygeoapi_plugins.provider.sparql.SPARQLProvider` as the provider's name.\n\n```\n providers:\n - type: feature\n name: pygeoapi_plugins.provider.sparql.SPARQLProvider\n data: /pygeoapi_plugins/tests/data/ne_110m_populated_places_simple.geojson\n id_field: id\n sparql_provider: GeoJSON\n sparql_endpoint: https://dbpedia.org/sparql\n sparql_subject: uri\n sparql_predicates:\n leader: dbpedia2:leaderName|dbp:leaderName\n population: dbo:populationTotal|dbp:populationCensus\n```\n\nIn this example, the SPARQL Provider wraps the GeoJSON Provider.\nThe SPARQL Provider only uses variables prefixed with sparql\\_ in the configuration.\n\n- `data`: The path to the data file used by the wrapped provider (GeoJSON Provider in this case).\n- `id_field`: The field that serves as the unique identifier for features in the data.\n- `sparql_provider`: The name of the provider that will handle the SPARQL query results (GeoJSON Provider in this case).\n- `sparql_endpoint`: The SPARQL endpoint URL to query for data.\n- `sparql_subject`: The SPARQL variable representing the subject URI in the query.\n- `sparql_predicates`: A mapping of attribute names to SPARQL predicates. These predicates will be used to query specific attributes in the SPARQL data source.\n\n## OGC API - Processes\n\nAdditional OGC API - Process are listed below\n\n### Intersector\n\nThe intersection process uses OGC API - Features Part 3: Filtering to return CQL intersections of features.\nAn example configuration in a pygeoapi configuration is below.\n\n```\n intersector:\n type: process\n processor:\n name: pygeoapi_plugins.process.intersect.IntersectionProcessor\n```\n\nThis plugin is used in https:/reference.geoconnex.us/.\n\n### Sitemap Generator\n\nThe Sitemap Generator process makes use of the XML formatter and OGC API - Features to generate a sitemap of the pygeoapi instance.\nThis can be used with the python package [sitemap-generator](https://github.com/cgs-earth/sitemap-generator) to generate a sitemap index.\nAn example configuration in a pygeoapi configuration is below.\n\n```\n sitemap-generator:\n type: process\n processor:\n name: pygeoapi_plugins.process.sitemap.SitemapProcessor\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "pygeoapi plugins",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/cgs-earth/pygeoapi-plugins"
},
"split_keywords": [
"cgs",
"pygeoapi",
"geopython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fcf6f4ba2b294a8b89a5aff67cba7df9896003879de16be0ba6bae07546b7cad",
"md5": "278983eaba5e70ce7ac9202e194a2ffc",
"sha256": "331edc42a70dffce720a917471639c65d5325162b4009e7e23fb05894930f997"
},
"downloads": -1,
"filename": "pygeoapi_plugins-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "278983eaba5e70ce7ac9202e194a2ffc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 24859,
"upload_time": "2024-03-25T23:17:03",
"upload_time_iso_8601": "2024-03-25T23:17:03.329983Z",
"url": "https://files.pythonhosted.org/packages/fc/f6/f4ba2b294a8b89a5aff67cba7df9896003879de16be0ba6bae07546b7cad/pygeoapi_plugins-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81ca513b1d2b6b7a8a7cdc50ec65df59c5a403ee824826e5414ca2c005fe0d82",
"md5": "db06e7afdeee5777b7996d9e0cee528f",
"sha256": "3d2410ad5cb82dcd1bb1d469e86bfdab98a74b9db5b4af3c45dda07d128e6093"
},
"downloads": -1,
"filename": "pygeoapi_plugins-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "db06e7afdeee5777b7996d9e0cee528f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21652,
"upload_time": "2024-03-25T23:17:08",
"upload_time_iso_8601": "2024-03-25T23:17:08.570509Z",
"url": "https://files.pythonhosted.org/packages/81/ca/513b1d2b6b7a8a7cdc50ec65df59c5a403ee824826e5414ca2c005fe0d82/pygeoapi_plugins-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 23:17:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cgs-earth",
"github_project": "pygeoapi-plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pygeoapi-plugins"
}
JSON
