# ra-rem
Python client stubs for the REM (Residential Electrification Model) API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1.0
- Package version: 0.1.8
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.8+
## Installation & Usage
### pip install
Run:
```sh
pip install ra-rem
```
Then import the package:
```python
import ra_rem
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import ra_rem
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import ra_rem
from ra_rem.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = ra_rem.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with ra_rem.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ra_rem.BuildingProfilerApi(api_client)
address = 'address_example' # str | The location of a home.
try:
# Get Home Profile
api_response = api_instance.building_profiler_get_home_profile(address)
print("The response of BuildingProfilerApi->building_profiler_get_home_profile:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling BuildingProfilerApi->building_profiler_get_home_profile: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BuildingProfilerApi* | [**building_profiler_get_home_profile**](docs/BuildingProfilerApi.md#building_profiler_get_home_profile) | **GET** /api/v1/building_profiler/home | Get Home Profile
*ResidentialElectrificationModelApi* | [**rem_get_by_address**](docs/ResidentialElectrificationModelApi.md#rem_get_by_address) | **GET** /api/v1/rem/address | Get By Address
*ResidentialElectrificationModelApi* | [**rem_get_by_profile**](docs/ResidentialElectrificationModelApi.md#rem_get_by_profile) | **POST** /api/v1/rem/profile | Get By Profile
## Documentation For Models
- [BuildingFeatures](docs/BuildingFeatures.md)
- [BuildingProfile](docs/BuildingProfile.md)
- [FuelData](docs/FuelData.md)
- [FuelDataRates](docs/FuelDataRates.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HeatingFuel](docs/HeatingFuel.md)
- [Impact](docs/Impact.md)
- [Metrics](docs/Metrics.md)
- [RemProfileRequest](docs/RemProfileRequest.md)
- [Savings](docs/Savings.md)
- [ValidUpgrade](docs/ValidUpgrade.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints require an API key for authorization. You can sign up for one [here](https://homes.rewiringamerica.org/api/developer-login).
Raw data
{
"_id": null,
"home_page": "https://github.com/rewiringamerica/ra-api-rem-py",
"name": "ra-rem",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Rewiring America, REM, electrification, utility, energy, emissions, savings",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/42/78/8824fd9933a312bbdf58c54899d016ec8a0deec96ac01c96d64332ded8aa/ra_rem-0.1.8.tar.gz",
"platform": null,
"description": "# ra-rem\nPython client stubs for the REM (Residential Electrification Model) API.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1.0\n- Package version: 0.1.8\n- Generator version: 7.10.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n### pip install\n\nRun:\n```sh\npip install ra-rem\n```\n\nThen import the package:\n```python\nimport ra_rem\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport ra_rem\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport ra_rem\nfrom ra_rem.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = ra_rem.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith ra_rem.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = ra_rem.BuildingProfilerApi(api_client)\n address = 'address_example' # str | The location of a home.\n\n try:\n # Get Home Profile\n api_response = api_instance.building_profiler_get_home_profile(address)\n print(\"The response of BuildingProfilerApi->building_profiler_get_home_profile:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling BuildingProfilerApi->building_profiler_get_home_profile: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BuildingProfilerApi* | [**building_profiler_get_home_profile**](docs/BuildingProfilerApi.md#building_profiler_get_home_profile) | **GET** /api/v1/building_profiler/home | Get Home Profile\n*ResidentialElectrificationModelApi* | [**rem_get_by_address**](docs/ResidentialElectrificationModelApi.md#rem_get_by_address) | **GET** /api/v1/rem/address | Get By Address\n*ResidentialElectrificationModelApi* | [**rem_get_by_profile**](docs/ResidentialElectrificationModelApi.md#rem_get_by_profile) | **POST** /api/v1/rem/profile | Get By Profile\n\n\n## Documentation For Models\n\n - [BuildingFeatures](docs/BuildingFeatures.md)\n - [BuildingProfile](docs/BuildingProfile.md)\n - [FuelData](docs/FuelData.md)\n - [FuelDataRates](docs/FuelDataRates.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [HeatingFuel](docs/HeatingFuel.md)\n - [Impact](docs/Impact.md)\n - [Metrics](docs/Metrics.md)\n - [RemProfileRequest](docs/RemProfileRequest.md)\n - [Savings](docs/Savings.md)\n - [ValidUpgrade](docs/ValidUpgrade.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints require an API key for authorization. You can sign up for one [here](https://homes.rewiringamerica.org/api/developer-login).\n",
"bugtrack_url": null,
"license": "LICENSE.md",
"summary": "Python client stubs for the REM (Residential Electrification Model) API",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/rewiringamerica/ra-api-rem-py",
"Repository": "https://github.com/rewiringamerica/ra-api-rem-py"
},
"split_keywords": [
"rewiring america",
" rem",
" electrification",
" utility",
" energy",
" emissions",
" savings"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f093f08e68b909ee46c92d2cdc6f9bf9a91823eb9238e89bb01ff38d93a12ac",
"md5": "2aa0f5227ad3cb1c5f6387b9e1d05677",
"sha256": "9c3a0f534966be089c360942fbdc73100f34b986e4d476d1444e30ab94bb8374"
},
"downloads": -1,
"filename": "ra_rem-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2aa0f5227ad3cb1c5f6387b9e1d05677",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 47883,
"upload_time": "2024-12-06T16:05:30",
"upload_time_iso_8601": "2024-12-06T16:05:30.988730Z",
"url": "https://files.pythonhosted.org/packages/9f/09/3f08e68b909ee46c92d2cdc6f9bf9a91823eb9238e89bb01ff38d93a12ac/ra_rem-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "42788824fd9933a312bbdf58c54899d016ec8a0deec96ac01c96d64332ded8aa",
"md5": "4f01a6ec632be0e9f438645b778de208",
"sha256": "4bc125af950cb62ae81854d8c44df05a1cdb2d031a9ad358ebabd0b7b921a79f"
},
"downloads": -1,
"filename": "ra_rem-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "4f01a6ec632be0e9f438645b778de208",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 31063,
"upload_time": "2024-12-06T16:05:32",
"upload_time_iso_8601": "2024-12-06T16:05:32.750221Z",
"url": "https://files.pythonhosted.org/packages/42/78/8824fd9933a312bbdf58c54899d016ec8a0deec96ac01c96d64332ded8aa/ra_rem-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 16:05:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rewiringamerica",
"github_project": "ra-api-rem-py",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "urllib3",
"specs": [
[
"<",
"3.0.0"
],
[
">=",
"1.25.3"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.8.2"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.7.1"
]
]
}
],
"tox": true,
"lcname": "ra-rem"
}
JSON
