# EC3 Python Wrapper
<p align="center"><img width="200" src="https://github.com/jbf1212/example-app-ec3-wrapper/blob/main/images/ec3_wrapper_logo.png"</p>
This is a Python wrapper for working with the Building Transparency EC3 API.
Documentation for the EC3 API can be found at [https://buildingtransparency.org/ec3/manage-apps/api-doc/api](https://buildingtransparency.org/ec3/manage-apps/api-doc/api)
This project is still early in development. Further documentation and functionality will continue to evolve as the project progresses.
## Installing
```
pip install ec3-python-wrapper
```
## Documentation
For documentation on how to use the EC3 Python Wrapper visit:
[https://ec3-python-wrapper.readthedocs.io/](https://ec3-python-wrapper.readthedocs.io/)
### Usage Examples
Some Jupyter Notebook examples are provided here:
* Overview of some available functions: [ec3_overview.ipynb](ec3_overview.ipynb)
* Querying and plotting materials: [ec3_materials_plot.ipynb](ec3_materials_plot.ipynb)
A Streamlit example app can be found here:
* EC3 Concrete Carbon Comparison by postal Code: [](https://jbf1212-example-app-ec3-wrapper-ec3-app-bd2ea4.streamlit.app/)
## Credits
* Obviously none of this would exist without the great efforts of the [Building Transparency](https://buildingtransparency.org/ec3) team and the EC3 database.
* Much of how this library has been structured was modeled off of the amazing work done on the [pyAirtable module](https://github.com/gtalarico/pyairtable).
## License
[MIT](https://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": "https://github.com/jbf1212/ec3-python-wrapper",
"name": "ec3-python-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ec3, api",
"author": "Jared Friedman",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/53/15/47575d5acbd42999ea4ebc445802321bf9cad0367ecacbc08b386aa189fa/ec3-python-wrapper-0.0.9.tar.gz",
"platform": null,
"description": "# EC3 Python Wrapper\r\n<p align=\"center\"><img width=\"200\" src=\"https://github.com/jbf1212/example-app-ec3-wrapper/blob/main/images/ec3_wrapper_logo.png\"</p>\r\n\r\nThis is a Python wrapper for working with the Building Transparency EC3 API.\r\nDocumentation for the EC3 API can be found at [https://buildingtransparency.org/ec3/manage-apps/api-doc/api](https://buildingtransparency.org/ec3/manage-apps/api-doc/api)\r\n\r\nThis project is still early in development. Further documentation and functionality will continue to evolve as the project progresses.\r\n\r\n## Installing\r\n\r\n```\r\npip install ec3-python-wrapper\r\n```\r\n\r\n## Documentation\r\n\r\nFor documentation on how to use the EC3 Python Wrapper visit:\r\n[https://ec3-python-wrapper.readthedocs.io/](https://ec3-python-wrapper.readthedocs.io/)\r\n\r\n### Usage Examples\r\n\r\nSome Jupyter Notebook examples are provided here:\r\n\r\n* Overview of some available functions: [ec3_overview.ipynb](ec3_overview.ipynb)\r\n* Querying and plotting materials: [ec3_materials_plot.ipynb](ec3_materials_plot.ipynb)\r\n\r\nA Streamlit example app can be found here:\r\n* EC3 Concrete Carbon Comparison by postal Code: [](https://jbf1212-example-app-ec3-wrapper-ec3-app-bd2ea4.streamlit.app/)\r\n\r\n## Credits\r\n\r\n* Obviously none of this would exist without the great efforts of the [Building Transparency](https://buildingtransparency.org/ec3) team and the EC3 database.\r\n* Much of how this library has been structured was modeled off of the amazing work done on the [pyAirtable module](https://github.com/gtalarico/pyairtable).\r\n\r\n## License\r\n[MIT](https://opensource.org/licenses/MIT)\r\n",
"bugtrack_url": null,
"license": "The MIT License (MIT)",
"summary": "A python wrapper around the EC3 api by Building Transparency",
"version": "0.0.9",
"project_urls": {
"Bug Tracker": "https://github.com/jbf1212/ec3-python-wrapper/issues",
"Homepage": "https://github.com/jbf1212/ec3-python-wrapper"
},
"split_keywords": [
"ec3",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38ffa0c6aad6547eeb43eff5b629b00e0ae000e1d5dc805d8f87511a9e8d30f2",
"md5": "f91ea16a03c43475ec73c43b5a0c783c",
"sha256": "43698a04f5734720f9dba2aeed6663f71893e8047c98e0fdd43288a55aacbceb"
},
"downloads": -1,
"filename": "ec3_python_wrapper-0.0.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f91ea16a03c43475ec73c43b5a0c783c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 12968,
"upload_time": "2024-09-17T04:07:12",
"upload_time_iso_8601": "2024-09-17T04:07:12.404286Z",
"url": "https://files.pythonhosted.org/packages/38/ff/a0c6aad6547eeb43eff5b629b00e0ae000e1d5dc805d8f87511a9e8d30f2/ec3_python_wrapper-0.0.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "531547575d5acbd42999ea4ebc445802321bf9cad0367ecacbc08b386aa189fa",
"md5": "198576f7f2669cc6b351770e9e5eb528",
"sha256": "04640d2296c525ee2c590d6e567a79ccf4f66867def2c33050fb46695159a170"
},
"downloads": -1,
"filename": "ec3-python-wrapper-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "198576f7f2669cc6b351770e9e5eb528",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10795,
"upload_time": "2024-09-17T04:07:13",
"upload_time_iso_8601": "2024-09-17T04:07:13.621439Z",
"url": "https://files.pythonhosted.org/packages/53/15/47575d5acbd42999ea4ebc445802321bf9cad0367ecacbc08b386aa189fa/ec3-python-wrapper-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 04:07:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jbf1212",
"github_project": "ec3-python-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ec3-python-wrapper"
}
JSON
