electrificationutils


Nameelectrificationutils JSON
Version 0.3.4 PyPI version JSON
download
home_pagehttps://github.com/GIT_USER_ID/GIT_REPO_ID
Summarysmallmodelsapi
upload_time2024-12-06 01:38:23
maintainerNone
docs_urlNone
authorOpenAPI Generator Community
requires_python<4.0,>=3.8
licenseNoLicense
keywords openapi openapi-generator smallmodelsapi
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # dml-small-models
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.3.4
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.8+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import electrificationutils
```

### 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 electrificationutils
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import electrificationutils
from electrificationutils.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 = electrificationutils.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with electrificationutils.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = electrificationutils.GGRFHVACUpdateApi(api_client)
    electric_efficiency = electrificationutils.HvacEfficiencyElectricDetailed() # HvacEfficiencyElectricDetailed | 

    try:
        # Ggrf Hvac Upgrade Btu Per Watt Hour
        api_response = api_instance.ggrf_hvac_upgrade_btu_per_watt_hour(electric_efficiency)
        print("The response of GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_btu_per_watt_hour**](docs/GGRFHVACUpdateApi.md#ggrf_hvac_upgrade_btu_per_watt_hour) | **GET** /api/v1/ggrf/hvac_upgrade/btu_per_watt_hour/ | Ggrf Hvac Upgrade Btu Per Watt Hour
*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_electric_to_electric**](docs/GGRFHVACUpdateApi.md#ggrf_hvac_upgrade_electric_to_electric) | **GET** /api/v1/ggrf/hvac_upgrade/electric_to_electric/ | Ggrf Hvac Upgrade Electric To Electric
*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_fossil_to_electric**](docs/GGRFHVACUpdateApi.md#ggrf_hvac_upgrade_fossil_to_electric) | **GET** /api/v1/ggrf/hvac_upgrade/fossil_to_electric/ | Ggrf Hvac Upgrade Fossil To Electric
*HealthImpactsApi* | [**query_health_impacts**](docs/HealthImpactsApi.md#query_health_impacts) | **GET** /api/v1/health_impacts/ | Query Health Impacts
*RangeUpgradeApi* | [**range_upgrade**](docs/RangeUpgradeApi.md#range_upgrade) | **GET** /api/v1/range_upgrade/ | Range Upgrade


## Documentation For Models

 - [EnergyQuantity](docs/EnergyQuantity.md)
 - [EnergyTradeoff](docs/EnergyTradeoff.md)
 - [GroupBy](docs/GroupBy.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HvacEfficiencyElectricDetailed](docs/HvacEfficiencyElectricDetailed.md)
 - [HvacEfficiencyFossilFuels](docs/HvacEfficiencyFossilFuels.md)
 - [HvacUpdateResults](docs/HvacUpdateResults.md)
 - [Metrics](docs/Metrics.md)
 - [RangeFuelType](docs/RangeFuelType.md)
 - [UpgradeOption](docs/UpgradeOption.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author






            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
    "name": "electrificationutils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, smallmodelsapi",
    "author": "OpenAPI Generator Community",
    "author_email": "team@openapitools.org",
    "download_url": "https://files.pythonhosted.org/packages/7d/1a/d5ab0523a1bb6e2b37e5951f2f498ec27dcb71834719ecd95d398d425705/electrificationutils-0.3.4.tar.gz",
    "platform": null,
    "description": "# dml-small-models\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\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.3.4\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\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport electrificationutils\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 electrificationutils\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 electrificationutils\nfrom electrificationutils.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 = electrificationutils.Configuration(\n    host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith electrificationutils.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = electrificationutils.GGRFHVACUpdateApi(api_client)\n    electric_efficiency = electrificationutils.HvacEfficiencyElectricDetailed() # HvacEfficiencyElectricDetailed | \n\n    try:\n        # Ggrf Hvac Upgrade Btu Per Watt Hour\n        api_response = api_instance.ggrf_hvac_upgrade_btu_per_watt_hour(electric_efficiency)\n        print(\"The response of GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling GGRFHVACUpdateApi->ggrf_hvac_upgrade_btu_per_watt_hour: %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*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_btu_per_watt_hour**](docs/GGRFHVACUpdateApi.md#ggrf_hvac_upgrade_btu_per_watt_hour) | **GET** /api/v1/ggrf/hvac_upgrade/btu_per_watt_hour/ | Ggrf Hvac Upgrade Btu Per Watt Hour\n*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_electric_to_electric**](docs/GGRFHVACUpdateApi.md#ggrf_hvac_upgrade_electric_to_electric) | **GET** /api/v1/ggrf/hvac_upgrade/electric_to_electric/ | Ggrf Hvac Upgrade Electric To Electric\n*GGRFHVACUpdateApi* | [**ggrf_hvac_upgrade_fossil_to_electric**](docs/GGRFHVACUpdateApi.md#ggrf_hvac_upgrade_fossil_to_electric) | **GET** /api/v1/ggrf/hvac_upgrade/fossil_to_electric/ | Ggrf Hvac Upgrade Fossil To Electric\n*HealthImpactsApi* | [**query_health_impacts**](docs/HealthImpactsApi.md#query_health_impacts) | **GET** /api/v1/health_impacts/ | Query Health Impacts\n*RangeUpgradeApi* | [**range_upgrade**](docs/RangeUpgradeApi.md#range_upgrade) | **GET** /api/v1/range_upgrade/ | Range Upgrade\n\n\n## Documentation For Models\n\n - [EnergyQuantity](docs/EnergyQuantity.md)\n - [EnergyTradeoff](docs/EnergyTradeoff.md)\n - [GroupBy](docs/GroupBy.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [HvacEfficiencyElectricDetailed](docs/HvacEfficiencyElectricDetailed.md)\n - [HvacEfficiencyFossilFuels](docs/HvacEfficiencyFossilFuels.md)\n - [HvacUpdateResults](docs/HvacUpdateResults.md)\n - [Metrics](docs/Metrics.md)\n - [RangeFuelType](docs/RangeFuelType.md)\n - [UpgradeOption](docs/UpgradeOption.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 do not require authorization.\n\n\n## Author\n\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "NoLicense",
    "summary": "smallmodelsapi",
    "version": "0.3.4",
    "project_urls": {
        "Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
        "Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " smallmodelsapi"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b821cb76958ff7073ffeb1b11b603e1878b426ed0bb3af18ad2bcb42fff508bc",
                "md5": "a5c96e78e551fe1de633a87f3a1b0541",
                "sha256": "748003554a4c67372ea37e1639a8086e5d93bbab46194a5561c365c2522c1d11"
            },
            "downloads": -1,
            "filename": "electrificationutils-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a5c96e78e551fe1de633a87f3a1b0541",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 50478,
            "upload_time": "2024-12-06T01:38:21",
            "upload_time_iso_8601": "2024-12-06T01:38:21.343102Z",
            "url": "https://files.pythonhosted.org/packages/b8/21/cb76958ff7073ffeb1b11b603e1878b426ed0bb3af18ad2bcb42fff508bc/electrificationutils-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d1ad5ab0523a1bb6e2b37e5951f2f498ec27dcb71834719ecd95d398d425705",
                "md5": "0e7d5226f14264c12fc18326df1f14d1",
                "sha256": "0cd0d214afe66814342e707e8037f05ae028e974971ee912edd73952d41a8d74"
            },
            "downloads": -1,
            "filename": "electrificationutils-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "0e7d5226f14264c12fc18326df1f14d1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 33025,
            "upload_time": "2024-12-06T01:38:23",
            "upload_time_iso_8601": "2024-12-06T01:38:23.814786Z",
            "url": "https://files.pythonhosted.org/packages/7d/1a/d5ab0523a1bb6e2b37e5951f2f498ec27dcb71834719ecd95d398d425705/electrificationutils-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-06 01:38:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GIT_USER_ID",
    "github_project": "GIT_REPO_ID",
    "github_not_found": true,
    "lcname": "electrificationutils"
}
        
Elapsed time: 0.39822s