| Name | fortlev-solar-sdk JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | A Python SDK for interacting with the Fortlev Solar API. |
| upload_time | 2024-10-08 17:41:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 Patrick Pasquini Ambrozini 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. |
| keywords |
solar
api
sdk
fortlev
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Fortlev Solar SDK Documentation
This SDK is designed to simplify the process of interacting with the Fortlev Solar API.
**Go to:** [Docs](https://patrickpasquini.github.io/fortlev_solar_sdk/)
### Installation
You can install the SDK using pip:
```bash
pip install fortlev_solar_sdk
```
### Quick Example
Here's a quick example of how to use the SDK to authenticate and fetch available surfaces:
```python
from fortlev_solar_sdk import FortlevSolarClient
client = FortlevSolarClient()
client.authenticate(username="username", pwd="password")
orders = client.orders(power=5.0, voltage="220", phase=1, surface="surface_id", city="city_id")
for order in orders:
print(order)
```
## API Reference
For a complete reference of available endpoints, visit the official API documentation:
[Fortlev Solar API Documentation](https://api-platform.fortlevsolar.app/partner/docs)
## Fortlev Solar Platform
To access the Fortlev Solar platform, where you can manage your orders and more, visit:
[Fortlev Solar Platform](https://fortlevsolar.app)
## Contributing
We welcome contributions to the SDK! If you'd like to report an issue or contribute to the project, please visit our [GitHub repository](https://github.com/patrickpasquini/fortlev_solar_sdk).
Raw data
{
"_id": null,
"home_page": null,
"name": "fortlev-solar-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Patrick Pasquini <contatopasquini@gmail.com>",
"keywords": "solar, API, SDK, Fortlev",
"author": null,
"author_email": "Patrick Pasquini <contatopasquini@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f4/e3/408dc58fb8649b9a7810982d34b0792ab8e2997b32481965073d0a12bf63/fortlev_solar_sdk-0.2.2.tar.gz",
"platform": null,
"description": "\n# Fortlev Solar SDK Documentation\n\nThis SDK is designed to simplify the process of interacting with the Fortlev Solar API.\n\n**Go to:** [Docs](https://patrickpasquini.github.io/fortlev_solar_sdk/)\n\n### Installation\n\nYou can install the SDK using pip:\n\n```bash\npip install fortlev_solar_sdk\n```\n\n### Quick Example\n\nHere's a quick example of how to use the SDK to authenticate and fetch available surfaces:\n\n```python\nfrom fortlev_solar_sdk import FortlevSolarClient\n\nclient = FortlevSolarClient()\nclient.authenticate(username=\"username\", pwd=\"password\")\norders = client.orders(power=5.0, voltage=\"220\", phase=1, surface=\"surface_id\", city=\"city_id\")\nfor order in orders:\n print(order)\n```\n\n## API Reference\n\nFor a complete reference of available endpoints, visit the official API documentation:\n\n[Fortlev Solar API Documentation](https://api-platform.fortlevsolar.app/partner/docs)\n\n## Fortlev Solar Platform\n\nTo access the Fortlev Solar platform, where you can manage your orders and more, visit:\n\n[Fortlev Solar Platform](https://fortlevsolar.app)\n\n## Contributing\n\nWe welcome contributions to the SDK! If you'd like to report an issue or contribute to the project, please visit our [GitHub repository](https://github.com/patrickpasquini/fortlev_solar_sdk).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Patrick Pasquini Ambrozini 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.",
"summary": "A Python SDK for interacting with the Fortlev Solar API.",
"version": "0.2.2",
"project_urls": {
"Repository": "https://github.com/patrickpasquini/fortlev_solar_sdk"
},
"split_keywords": [
"solar",
" api",
" sdk",
" fortlev"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad737e6e107b52760e50a515d66864538b8a031d57e2fe779cc0e1c1a495aba7",
"md5": "a77f2bfb114a636e32519b11551488bc",
"sha256": "d9a4efea75554115efd546a3d0f4ff8fc530c746110d1420a92ed66273de5637"
},
"downloads": -1,
"filename": "fortlev_solar_sdk-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a77f2bfb114a636e32519b11551488bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12716,
"upload_time": "2024-10-08T17:41:37",
"upload_time_iso_8601": "2024-10-08T17:41:37.674161Z",
"url": "https://files.pythonhosted.org/packages/ad/73/7e6e107b52760e50a515d66864538b8a031d57e2fe779cc0e1c1a495aba7/fortlev_solar_sdk-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f4e3408dc58fb8649b9a7810982d34b0792ab8e2997b32481965073d0a12bf63",
"md5": "579b66b3685445611bca7dd67d69b58a",
"sha256": "eeca0f81c78428e876f8146b7da8b26baa1c926a27a7bd3cbf76dcc3fb7bbc18"
},
"downloads": -1,
"filename": "fortlev_solar_sdk-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "579b66b3685445611bca7dd67d69b58a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11299,
"upload_time": "2024-10-08T17:41:39",
"upload_time_iso_8601": "2024-10-08T17:41:39.320252Z",
"url": "https://files.pythonhosted.org/packages/f4/e3/408dc58fb8649b9a7810982d34b0792ab8e2997b32481965073d0a12bf63/fortlev_solar_sdk-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 17:41:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "patrickpasquini",
"github_project": "fortlev_solar_sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "fortlev-solar-sdk"
}
