https://github.com/bird-house/nandu
Nandu is a demo for ogcapi-process using pygeoapi (like the Emu for PyWPS).
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.1%) to scientific vocabulary
Keywords
Repository
Nandu is a demo for ogcapi-process using pygeoapi (like the Emu for PyWPS).
Basic Info
- Host: GitHub
- Owner: bird-house
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://nandu.readthedocs.io/en/latest/
- Size: 139 KB
Statistics
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
- Releases: 1
Topics
Metadata Files
README.md
Nandu
Nandu - the bird This bird looks like an Emu but its not. The name Nandu is mostly used in European countries. Otherwise this bird is called Rhea.
Nandu is an OGC API - Processes implementation using pygeoapi. It provides simple processes like a "Say Hello" greeting process.
Features
- Hello World Process: Returns a simple greeting message.
- Echo Process: Returns an echo message after some time.
Quick Guide
Clone the repository:
console
git clone https://github.com/cehbrecht/nandu.git
cd nandu
Create the Conda environment:
console
conda env create -f environment.yml
conda activate nandu
You can use make to run the installation:
console
make install
... and start the service:
console
make start
Installation
Prerequisites
Install from GitHub
Clone the repository:
console
git clone https://github.com/cehbrecht/nandu.git
cd nandu
Create the Conda environment:
console
conda env create -f environment.yml
conda activate nandu
Install the project dependencies using Flit:
console
flit install
Configuration
Edit pygeoapi config (optional):
console
vim pygeoapi-config.yml
Export paths to configs:
console
export PYGEOAPI_CONFIG=pygeoapi-config.yml
export PYGEOAPI_OPENAPI=pygeoapi-openapi.yml
Update the OpenAPI configuration:
console
pygeoapi openapi generate $PYGEOAPI_CONFIG --output-file $PYGEOAPI_OPENAPI
Usage
Start the pygeoapi server and expose the processes:
console
pygeoapi serve
This will start the API on http://localhost:5000.
List all processes:
http://localhost:5000/processes
View process details of "Hello World": http://localhost:5000/processes/hello-world
Execute the process:
console
curl -X POST http://localhost:5000/processes/hello-world/execution \
-H "Content-Type: application/json" \
-d '{
"inputs": {
"name": "Alice"
}
}'
Development
Run tests:
console
make test
Check coding style:
console
make lint
Build docs:
console
make docs
Release
Please check the developer guide.
Examples
See usage examples for the processes in the notebooks folder.
Docker
You can also use a docker deployment.
Build images:
console
docker-compose build
Start container:
console
docker-compose up
License
This project is licensed under the Apache License version 2.
Owner
- Name: bird-house
- Login: bird-house
- Kind: organization
- Website: http://bird-house.github.io/
- Repositories: 63
- Profile: https://github.com/bird-house
Making Web Processing Services easy
GitHub Events
Total
- Delete event: 10
- Push event: 40
- Pull request review event: 2
- Pull request review comment event: 2
- Pull request event: 20
- Create event: 12
Last Year
- Delete event: 10
- Push event: 40
- Pull request review event: 2
- Pull request review comment event: 2
- Pull request event: 20
- Create event: 12
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 14
- Average time to close issues: N/A
- Average time to close pull requests: about 8 hours
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 0
- Pull requests: 14
- Average time to close issues: N/A
- Average time to close pull requests: about 8 hours
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 2
Top Authors
Issue Authors
- cehbrecht (1)
Pull Request Authors
- cehbrecht (15)
- dependabot[bot] (4)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- flask <3.0
- pygeoapi >=0.17.0
- python >=3.9
- werkzeug <3.0
- actions/checkout 692973e3d937129bcbf40652eb9f2f61becf3332 composite
- actions/setup-python f677139bbe7f9c59b41e40162b753c062f5d49a3 composite
- mamba-org/setup-micromamba f8b8a1e23a26f60a44c853292711bacfd3eac822 composite
- step-security/harden-runner 91182cccc01eb5e619899d80e4e971d6181294a7 composite
- geopython/pygeoapi latest build
- birdhouse/nandu latest