openagua-client
Client API. A very thin wrapper around the REST API.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (5.5%) to scientific vocabulary
Repository
Client API. A very thin wrapper around the REST API.
Basic Info
- Host: GitHub
- Owner: openagua
- License: mit
- Language: Python
- Default Branch: main
- Size: 23.4 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 5
Metadata Files
README.md
openagua-client
A very thin wrapper around the OpenAgua web API.
Usage
To use this, you need an API key from OpenAgua. Once you have that, you can supply it from an environment variable called OA_SECRET_KEY or directly as an argument to the client.
Here are two examples demonstrating each approach.
Example 1
In this example, the API key is in the environment variable OA_SECRET_KEY. Note that this may be loaded dynamically using, for example, dot_env
python
from openagua_client import Client as OA
oa = OA()
network = oa.get_network(77)
Example 2
The key is supplied directly. Note that it is best practice to never hard code secrets. Therefore, that is not done in this example, though technically it could be done. Using environment variables for keys is best practice.
python
import os
from openagua_client import Client as OA
oa_api_key = os.environ['MY_OPENAGUA_API_KEY']
oa = OA(api_key=oa_api_key)
network = oa.get_network(77)
Owner
- Name: OpenAgua
- Login: openagua
- Kind: organization
- Website: www.openagua.org
- Repositories: 21
- Profile: https://github.com/openagua
Collaborative water system modeling
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Rheinheimer
given-names: David E.
orcid: https://orcid.org/0000-0003-1525-9069
title: "OpenAgua Client"
version: 0.2.3
date-released: 2022-01-02
GitHub Events
Total
Last Year
Committers
Last synced: over 3 years ago
All Time
- Total Commits: 22
- Total Committers: 2
- Avg Commits per committer: 11.0
- Development Distribution Score (DDS): 0.364
Top Committers
| Name | Commits | |
|---|---|---|
| David Rheinheimer | h****n@g****m | 14 |
| David Rheinheimer | r****r@u****m | 8 |
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 0
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- drheinheimer (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 12 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 7
- Total maintainers: 1
pypi.org: openagua-client
A very thin wrapper around the OpenAgua web API
- Homepage: https://github.com/openagua/openagua-client
- Documentation: https://openagua-client.readthedocs.io/
- License: MIT
-
Latest release: 0.2.3
published almost 4 years ago
Rankings
Maintainers (1)
Dependencies
- certifi ==2020.12.5
- chardet ==4.0.0
- idna ==2.10
- requests ==2.25.1
- urllib3 ==1.26.4
- requests *