initial commit

.gitignore

@@ -0,0 +1,95 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+coverage-report
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# ignore backup files etc
+*.bak
+*.old

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Green Building Registry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,47 @@
+# Py-SEED: ap API client for the SEED Platform
+
+This provides two Python clients for interacting with the SEED Platform Api.
+(One is read only).
+
+SEED (Standard Energy Efficiency Data Platform™) is an open source
+"web-based application that helps organizations easily manage data on the
+energy performance of large groups of buildings" funded by the United States
+Department of Energy.
+
+More information can be found here:
+* https://energy.gov/eere/buildings/standard-energy-efficiency-data-platform
+* http://seedinfo.lbl.gov/
+* https://github.com/SEED-platform
+
+
+Note the clients do not provide per api-call methods, but does provide
+the standard CRUD methods: get, list, put, post, patch, delete
+
+The intended use of these clients is to be futher subclassed or wrapped in
+functions to provide the desired functionality. The CRUD methods are provided
+via mixins so its possible to create a client for example without the ability
+to delete by subclassing SEEDBaseClient and adding only the mixins
+that provided the Create, Read and Update capabilities.
+
+Basic usage for the provided clients is below.
+
+Usage:
+```python
+from pyseed import SEEDReadWriteClient
+
+seed_client = SEEDReadWriteClient(
+    your_org_id,
+    username=your_username,
+    password=your_password,
+    base_url=url_of_your_seed_host,
+    )
+
+# list all properties
+seed_client.list(endpoint='properties')
+
+# get a single property
+seed_client.get(property_pk, endpoint='properties')
+
+N.B. this client is undergoing development and should be considered
+experimental.
+```