Client api to interact with openergy platform
## Suggested conda env
<pre>
openpyxl>=2.4.7,<3.0.0
requests>=2.14.2,<3.0.0
nose>=1.3.7,<2.0.0
pandas>=0.20.1,<0.21.0
pytables>=3.2.0,<4.0
</pre>
## Url endpoints philosophy
Mainly inspired by [rest_framework simple router actions](http://www.django-rest-framework.org/api-guide/routers/#simplerouter).
## Examples
<pre>
from openergy import set_client, select_series
client = set_client("login", "password", "host")
</pre>
### select series
<pre>
# returns a pandas Series object
se = select_series("993e2f73-20ef-4f60-8e06-d81d6cefbc9a")
</pre>
### create local database
<pre>
from openergy import LocalDatabase
db = LocalDatabase(db_dir_path)
# download one series
# (local_se is not a pandas series but a local database series object)
local_se = db.get_local_series(
"my_project",
"analysis", # importer, cleaner or analysis
"my_analysis",
"se1")
local_se.download()
# se1 is a pandas series
se1 = local_se.data
# download multiple series
db.download_all_series(
my_project,
generator_model=analysis, # importer, cleaner or analysis
generator_name=my_analysis)
# 1. local se1 will be deleted and downloaded again
# 2. all project will be downloaded if no generator has been specified
# work with series
se1 = db.get_local_series(
"my_project",
"analysis",
"my_analysis",
"se1").data
</pre>
1 maintainer
Metadata
1 maintainer
Release files for openergy 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| openergy-3.1.0.tar.gz | 28.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openergy-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 62.0 kB
Release files / openergy-3.1.0.tar.gz
| Download URL | openergy-3.1.0.tar.gz |
|---|---|
| Size | 28.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88e4069efeb16d8fd3db9a09786165ba3165a0819cd87aac17bd399244e738da
|
|
BLAKE2b-256 checksum How to use checksums |
a57b66fdcd0031af8a995eb7f7c9ffecc86bae410377a2f3a046836b84a3f85b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / openergy-3.1.0-py3-none-any.whl
| Download URL | openergy-3.1.0-py3-none-any.whl |
|---|---|
| Size | 33.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44e12cfed0571199461bee55a506adf3e16cd23a0e743e5aee3435cd7da9ef8a
|
|
BLAKE2b-256 checksum How to use checksums |
532622add590cd586780c0edb2a84ebe729d9d9842e6209c8891c35eaf8fe00c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for openergy 3.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
