Skip to main content

No project description provided

Project description

# openergy

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>


Project details


Release history Release notifications

This version
History Node

3.1.4

History Node

3.1.3

History Node

3.1.2

History Node

3.1.1

History Node

3.1.0

History Node

3.0.1

History Node

3.0.0

History Node

2.1.0

History Node

2.0.2

History Node

2.0.1

History Node

2.0.0

History Node

1.0.0

History Node

0.3.0

History Node

0.2.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
openergy-3.1.4-py3-none-any.whl (34.0 kB) Copy SHA256 hash SHA256 Wheel py3 Mar 16, 2018
openergy-3.1.4.tar.gz (28.8 kB) Copy SHA256 hash SHA256 Source None Mar 16, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page