# Python wrapper for GeoServer REST API
[](https://pepy.tech/project/geoserver-rest)
[](https://opensource.org/licenses/MIT)
[](https://github.com/psf/black)
[](https://flake8.pycqa.org/)
[](https://pycqa.github.io/isort/)
[](https://github.com/pre-commit/pre-commit)
## Full documentation
The documentation for this project is moved here: [https://geoserver-rest.readthedocs.io/](https://geoserver-rest.readthedocs.io/).
## Overview
The `geoserver-rest` package is useful for the management of geospatial data in [GeoServer](http://geoserver.org/). The package is useful for the creating, updating and deleting geoserver workspaces, stores, layers, and style files.
## Installation
```python
conda install -c conda-forge geoserver-rest
```
For the `pip` installation, check the [official documentation of geoserver-rest](https://geoserver-rest.readthedocs.io/en/latest/installation.html)
## Some examples
Please check the [https://geoserver-rest.readthedocs.io/](https://geoserver-rest.readthedocs.io/) for full documentation.
```python
# Import the library
from geo.Geoserver import Geoserver
# Initialize the library
geo = Geoserver('http://127.0.0.1:8080/geoserver', username='admin', password='geoserver')
# For creating workspace
geo.create_workspace(workspace='demo')
# For uploading raster data to the geoserver
geo.create_coveragestore(layer_name='layer1', path=r'path\to\raster\file.tif', workspace='demo')
# For creating postGIS connection and publish postGIS table
geo.create_featurestore(store_name='geo_data', workspace='demo', db='postgres', host='localhost', pg_user='postgres',
pg_password='admin')
geo.publish_featurestore(workspace='demo', store_name='geo_data', pg_table='geodata_table_name')
# For uploading SLD file and connect it with layer
geo.upload_style(path=r'path\to\sld\file.sld', workspace='demo')
geo.publish_style(layer_name='geoserver_layer_name', style_name='sld_file_name', workspace='demo')
# For creating the style file for raster data dynamically and connect it with layer
geo.create_coveragestyle(raster_path=r'path\to\raster\file.tiff', style_name='style_1', workspace='demo',
color_ramp='RdYiGn')
geo.publish_style(layer_name='geoserver_layer_name', style_name='raster_file_name', workspace='demo')
# delete workspace
geo.delete_workspace(workspace='demo')
# delete layer
geo.delete_layer(layer_name='agri_final_proj', workspace='demo')
# delete style file
geo.delete_style(style_name='kamal2', workspace='demo')
```
## Contribution
Geoserver-rest is the open source library written in python and contributors are needed to keep this library moving forward. Any kind of contributions are welcome. Here are the basic rule for the new contributors:
1. Please use the request library for the http request.
2. One feature per pull request (If the PR is huge, you need to create a issue and discuss).
3. Please add the update about your PR on the [change log documentation](https://github.com/gicait/geoserver-rest/blob/master/docs/source/change_log.rst#master-branch) as well.
## Citation
Full paper is available here: https://doi.org/10.5194/isprs-archives-XLVI-4-W2-2021-91-2021
```
@Article{isprs-archives-XLVI-4-W2-2021-91-2021,
AUTHOR = {Tek Bahadur Kshetri, Angsana Chaksana and Shraddha Sharma},
TITLE = {THE ROLE OF OPEN-SOURCE PYTHON PACKAGE GEOSERVER-REST IN WEB-GIS DEVELOPMENT},
JOURNAL = {The International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences},
VOLUME = {XLVI-4/W2-2021},
YEAR = {2021},
PAGES = {91--96},
URL = {https://www.int-arch-photogramm-remote-sens-spatial-inf-sci.net/XLVI-4-W2-2021/91/2021/},
DOI = {10.5194/isprs-archives-XLVI-4-W2-2021-91-2021}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/iamtekson/geoserver-rest-python",
"name": "geoserver-rest",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "geoserver-rest-python, geoserver rest, python geoserver, geoserver api, api, rest geoserver, python, geoserver python, geoserver rest",
"author": "Tek Kshetri",
"author_email": "iamtekson@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/54/d6/37143029c5063ee3eed8fcc907d443a88c6493e052160aab354df135404c/geoserver_rest-2.8.3.tar.gz",
"platform": null,
"description": "# Python wrapper for GeoServer REST API\n\n[](https://pepy.tech/project/geoserver-rest)\n[](https://opensource.org/licenses/MIT)\n\n[](https://github.com/psf/black)\n[](https://flake8.pycqa.org/)\n[](https://pycqa.github.io/isort/)\n[](https://github.com/pre-commit/pre-commit)\n\n## Full documentation\n\nThe documentation for this project is moved here: [https://geoserver-rest.readthedocs.io/](https://geoserver-rest.readthedocs.io/).\n\n## Overview\n\nThe `geoserver-rest` package is useful for the management of geospatial data in [GeoServer](http://geoserver.org/). The package is useful for the creating, updating and deleting geoserver workspaces, stores, layers, and style files.\n\n## Installation\n\n```python\nconda install -c conda-forge geoserver-rest\n```\n\nFor the `pip` installation, check the [official documentation of geoserver-rest](https://geoserver-rest.readthedocs.io/en/latest/installation.html)\n\n## Some examples\n\nPlease check the [https://geoserver-rest.readthedocs.io/](https://geoserver-rest.readthedocs.io/) for full documentation.\n\n```python\n# Import the library\nfrom geo.Geoserver import Geoserver\n\n# Initialize the library\ngeo = Geoserver('http://127.0.0.1:8080/geoserver', username='admin', password='geoserver')\n\n# For creating workspace\ngeo.create_workspace(workspace='demo')\n\n# For uploading raster data to the geoserver\ngeo.create_coveragestore(layer_name='layer1', path=r'path\\to\\raster\\file.tif', workspace='demo')\n\n# For creating postGIS connection and publish postGIS table\ngeo.create_featurestore(store_name='geo_data', workspace='demo', db='postgres', host='localhost', pg_user='postgres',\n pg_password='admin')\ngeo.publish_featurestore(workspace='demo', store_name='geo_data', pg_table='geodata_table_name')\n\n# For uploading SLD file and connect it with layer\ngeo.upload_style(path=r'path\\to\\sld\\file.sld', workspace='demo')\ngeo.publish_style(layer_name='geoserver_layer_name', style_name='sld_file_name', workspace='demo')\n\n# For creating the style file for raster data dynamically and connect it with layer\ngeo.create_coveragestyle(raster_path=r'path\\to\\raster\\file.tiff', style_name='style_1', workspace='demo',\n color_ramp='RdYiGn')\ngeo.publish_style(layer_name='geoserver_layer_name', style_name='raster_file_name', workspace='demo')\n\n# delete workspace\ngeo.delete_workspace(workspace='demo')\n\n# delete layer\ngeo.delete_layer(layer_name='agri_final_proj', workspace='demo')\n\n# delete style file\ngeo.delete_style(style_name='kamal2', workspace='demo')\n```\n\n## Contribution\n\nGeoserver-rest is the open source library written in python and contributors are needed to keep this library moving forward. Any kind of contributions are welcome. Here are the basic rule for the new contributors:\n\n1. Please use the request library for the http request.\n2. One feature per pull request (If the PR is huge, you need to create a issue and discuss).\n3. Please add the update about your PR on the [change log documentation](https://github.com/gicait/geoserver-rest/blob/master/docs/source/change_log.rst#master-branch) as well.\n\n\n## Citation\n\nFull paper is available here: https://doi.org/10.5194/isprs-archives-XLVI-4-W2-2021-91-2021\n\n```\n@Article{isprs-archives-XLVI-4-W2-2021-91-2021,\n AUTHOR = {Tek Bahadur Kshetri, Angsana Chaksana and Shraddha Sharma},\n TITLE = {THE ROLE OF OPEN-SOURCE PYTHON PACKAGE GEOSERVER-REST IN WEB-GIS DEVELOPMENT},\n JOURNAL = {The International Archives of the Photogrammetry, Remote Sensing and Spatial Information Sciences},\n VOLUME = {XLVI-4/W2-2021},\n YEAR = {2021},\n PAGES = {91--96},\n URL = {https://www.int-arch-photogramm-remote-sens-spatial-inf-sci.net/XLVI-4-W2-2021/91/2021/},\n DOI = {10.5194/isprs-archives-XLVI-4-W2-2021-91-2021}\n }\n```\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Package for GeoServer rest API",
"version": "2.8.3",
"project_urls": {
"Homepage": "https://github.com/iamtekson/geoserver-rest-python"
},
"split_keywords": [
"geoserver-rest-python",
" geoserver rest",
" python geoserver",
" geoserver api",
" api",
" rest geoserver",
" python",
" geoserver python",
" geoserver rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b80e624e5be49ffa69bd4bad4b2254bcf0f0af8340e52edffbc599879cdd4dfd",
"md5": "6a4a1a171a57be82ce878fa316cd98aa",
"sha256": "3d8bf5c4e769e0e1c516a8372346f344ed6f63eb811f1eea5ac8b4bd79ebf703"
},
"downloads": -1,
"filename": "geoserver_rest-2.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a4a1a171a57be82ce878fa316cd98aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 23781,
"upload_time": "2024-08-06T16:25:13",
"upload_time_iso_8601": "2024-08-06T16:25:13.221916Z",
"url": "https://files.pythonhosted.org/packages/b8/0e/624e5be49ffa69bd4bad4b2254bcf0f0af8340e52edffbc599879cdd4dfd/geoserver_rest-2.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "54d637143029c5063ee3eed8fcc907d443a88c6493e052160aab354df135404c",
"md5": "0747940ccd5fbee656eb9c1ece6e9a93",
"sha256": "eefc281151952cd92e14f0e51ececb0d5b5980d858cf116edb72928b620bb0dd"
},
"downloads": -1,
"filename": "geoserver_rest-2.8.3.tar.gz",
"has_sig": false,
"md5_digest": "0747940ccd5fbee656eb9c1ece6e9a93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 30667,
"upload_time": "2024-08-06T16:25:14",
"upload_time_iso_8601": "2024-08-06T16:25:14.841175Z",
"url": "https://files.pythonhosted.org/packages/54/d6/37143029c5063ee3eed8fcc907d443a88c6493e052160aab354df135404c/geoserver_rest-2.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-06 16:25:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iamtekson",
"github_project": "geoserver-rest-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "geoserver-rest"
}
JSON
