-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fixed readme with examples , features and few guides
- Loading branch information
1 parent
d3786e7
commit 5012996
Showing
1 changed file
with
114 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,125 @@ | ||
| # geoserverx | ||
| A GeoServer REST API client influenced by HTTPX | ||
| # GeoServerX | ||
|
|
||
| ----------- | ||
| A modern, powerful GeoServer REST API client influenced by HTTPX, offering Sync, Async, and CLI capabilities. | ||
|
|
||
| `geoserverx` allows `Sync`, `Async` as well as `CLI` Capabilities to talk to your GeoServer REST APIs which makes it ideal to be used in software development project which relies on content of GeoServer. | ||
| [](https://pepy.tech/project/geoserverx) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/psf/black) | ||
| [](https://github.com/astral-sh/ruff) | ||
| [](https://pycqa.github.io/isort/) | ||
| [](https://squidfunk.github.io/mkdocs-material/) | ||
|
|
||
| Here is a simplistic view of how geoserverx works under the hood | ||
|  | ||
| ## Features | ||
|
|
||
| - 🚀 Synchronous and Asynchronous API support | ||
| - 🖥️ Command Line Interface (CLI) | ||
| - 🔄 Complete GeoServer REST API coverage | ||
| - 🏗️ Modern Pythonic interface | ||
| - 📦 Easy to install and use | ||
| - 📝 Type hints for better development experience | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| pip install geoserverx | ||
| ``` | ||
| ## Quick Start | ||
| ### Synchronous Usage | ||
| ```python | ||
| from geoserverx._sync.gsx import SyncGeoServerX | ||
|
|
||
| # Initialize with default GeoServer settings | ||
| # Default: URL=http://localhost:8080/geoserver/rest, username=admin, password=geoserver | ||
| geo_server = SyncGeoServerX() | ||
|
|
||
| ## Contribution guide | ||
| # Custom initialization | ||
| geo_server = SyncGeoServerX( | ||
| url="http://your-server:8080/geoserver/rest", | ||
| username="your_username", | ||
| password="your_password" | ||
| ) | ||
|
|
||
| ### Feature/Bug request | ||
| Please open new issue if you want to report any bug or send feature request | ||
| # Get all workspaces | ||
| workspaces = geo_server.get_all_workspaces() | ||
|
|
||
| ### Running on local | ||
| `geoserverx` is built with [poetry](https://python-poetry.org/) and it uses following dependencies and dev-dependencies | ||
| # Access workspace information | ||
| print(workspaces) # Print Workspaces Model | ||
| print(workspaces.workspaces) # Print detailed list of workspaces | ||
| print(workspaces.workspaces.workspace[0].name) # Print first workspace name | ||
| ``` | ||
|
|
||
|  "layout") | ||
| ### Asynchronous Usage | ||
| ```python | ||
| from geoserverx._async.gsx import AsyncGeoServerX | ||
| import asyncio | ||
|
|
||
| async def main(): | ||
| geo_server = AsyncGeoServerX() | ||
| workspaces = await geo_server.get_all_workspaces() | ||
| print(workspaces) | ||
|
|
||
| asyncio.run(main()) | ||
| ``` | ||
|
|
||
| ### CLI Usage | ||
| ```bash | ||
| # Get help | ||
| geoserverx --help | ||
|
|
||
| # List workspaces | ||
| geoserverx workspaces list | ||
|
|
||
| # Add a new workspace | ||
| geoserverx workspaces create --name my_workspace | ||
| ``` | ||
|
|
||
| ## Documentation | ||
| Detailed documentation is available through [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) | ||
|
|
||
| ## Development Setup | ||
| Install Poetry (dependency management tool): | ||
| ```bash | ||
| curl -sSL https://install.python-poetry.org | python3 - | ||
| ``` | ||
| ```bash | ||
| # Clone the repository: | ||
| git clone https://github.com/geobeyond/geoserverx.git | ||
| cd geoserverx | ||
| ``` | ||
| ```bash | ||
| # Install dependencies: | ||
| poetry install | ||
| ``` | ||
| ```bash | ||
|
|
||
| # Activate virtual environment: | ||
| poetry shell | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| We welcome contributions! Here's how you can help: | ||
|
|
||
| - Check for open issues or create a new one to discuss new features or bugs. | ||
| - Fork the repo and create a new branch for your contribution. | ||
| - Write your code and tests. | ||
| - Send a pull request. | ||
|
|
||
| ## Development Guidelines | ||
|
|
||
| - Follow [Black](https://black.readthedocs.io/en/stable/) code style | ||
| - Use [isort](https://pycqa.github.io/isort/index.html) ([black profile](https://pycqa.github.io/isort/docs/configuration/black_compatibility.html)) for import sorting | ||
| - Use [Ruff](https://docs.astral.sh/ruff/) for linting | ||
| - Ensure all tests pass | ||
| - Add tests for new features | ||
| - Update documentation as needed | ||
|
|
||
| ## Bug Reports and Feature Requests | ||
| Please use the GitHub issue tracker to report bugs or request features. | ||
|
|
||
| ## License | ||
| This project is licensed under the MIT License - see the LICENSE file for details. | ||
|
|
||
| ## Acknowledgments | ||
| - HTTPX for inspiration | ||
| - GeoServer community | ||
| - All contributors who have helped shape this project |