| Name | sems-portal-api JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | A small package that wraps a few of the SEMS Portal apis |
| upload_time | 2023-12-10 00:51:53 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.5 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
aiohttp
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SEMS Portal
## Description
SEMS Portal is a simple wrapper designed to interact with various APIs exposed by a specific website. It simplifies the process of sending requests and handling responses, making it easier for developers to integrate and work with the available services.
## Getting Started
### Prerequisites
Before you begin, ensure you have met the following requirements:
- Python version >=3.5
### Installation
To install SEMS Portal API, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/andrewgierens/sems_portal_api.git
```
2. Install the required packages:
```bash
pip install -r requirements.txt
```
### Usage
To use SEMS Portal, you need to have Python and `aiohttp` installed. Here’s a quick example to get you started:
```python
import aiohttp
import asyncio
from sems_portal_api import login_to_sems, set_region
async def main():
set_region('eu')
async with aiohttp.ClientSession() as session:
account = "your_account"
password = "your_password"
data = await login_to_sems(session, account, password)
print(data)
if __name__ == "__main__":
asyncio.run(main())
```
In this example, we import the required modules and define an `async` main function. Inside this function, we create an `aiohttp.ClientSession`, which is used to send an HTTP request to the SEMS portal for logging in. Replace `"your_account"` and `"your_password"` with your actual login credentials.
The `login_to_sems` function takes three parameters: the session, account, and password, and it returns the data received from the SEMS portal. The returned data is then printed to the console.
For testing the demo account credentials may be used:
```python
account = "demo@goodwe.com"
password = "GoodweSems123!@#"
```
## Contributing
Contributions to SEMS Portal are welcome and appreciated. If you have any suggestions or bug reports, please open an issue in the repository.
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
## License
This project is licensed under the GNU GPLv3 License - see the [LICENSE.md](LICENSE.md) file for details.
## Contact
If you have any questions or want to reach out, you can contact me at apgierens@gmail.com
# Contributors
<!-- readme: contributors -start -->
<table>
<tr>
<td align="center">
<a href="https://github.com/andrewgierens">
<img src="https://avatars.githubusercontent.com/u/4150500?v=4" width="100;" alt="andrewgierens"/>
<br />
<sub><b>Andrew Gierens</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/ygerlach">
<img src="https://avatars.githubusercontent.com/u/100762533?v=4" width="100;" alt="ygerlach"/>
<br />
<sub><b>Yannis Gerlach</b></sub>
</a>
</td></tr>
</table>
<!-- readme: contributors -end -->
Raw data
{
"_id": null,
"home_page": "",
"name": "sems-portal-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Andrew Gierens <apgierens@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1b/22/f7ea586f0109b83b443a7e2eaed3eaa09c84ef1c7174e7ab64856454d619/sems_portal_api-0.1.1.tar.gz",
"platform": null,
"description": "# SEMS Portal\n\n## Description\nSEMS Portal is a simple wrapper designed to interact with various APIs exposed by a specific website. It simplifies the process of sending requests and handling responses, making it easier for developers to integrate and work with the available services.\n\n## Getting Started\n\n### Prerequisites\nBefore you begin, ensure you have met the following requirements:\n- Python version >=3.5\n\n### Installation\nTo install SEMS Portal API, follow these steps:\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/andrewgierens/sems_portal_api.git\n ```\n\n2. Install the required packages:\n ```bash\n pip install -r requirements.txt\n ```\n\n### Usage\nTo use SEMS Portal, you need to have Python and `aiohttp` installed. Here\u2019s a quick example to get you started:\n\n```python\nimport aiohttp\nimport asyncio\nfrom sems_portal_api import login_to_sems, set_region\n\nasync def main():\n set_region('eu')\n async with aiohttp.ClientSession() as session:\n account = \"your_account\"\n password = \"your_password\"\n \n data = await login_to_sems(session, account, password)\n print(data)\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\nIn this example, we import the required modules and define an `async` main function. Inside this function, we create an `aiohttp.ClientSession`, which is used to send an HTTP request to the SEMS portal for logging in. Replace `\"your_account\"` and `\"your_password\"` with your actual login credentials.\n\nThe `login_to_sems` function takes three parameters: the session, account, and password, and it returns the data received from the SEMS portal. The returned data is then printed to the console.\n\n\nFor testing the demo account credentials may be used:\n```python\naccount = \"demo@goodwe.com\"\npassword = \"GoodweSems123!@#\"\n```\n\n## Contributing\nContributions to SEMS Portal are welcome and appreciated. If you have any suggestions or bug reports, please open an issue in the repository.\n[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).\n\n## License\nThis project is licensed under the GNU GPLv3 License - see the [LICENSE.md](LICENSE.md) file for details.\n\n## Contact\nIf you have any questions or want to reach out, you can contact me at apgierens@gmail.com\n\n# Contributors\n<!-- readme: contributors -start -->\n<table>\n<tr>\n <td align=\"center\">\n <a href=\"https://github.com/andrewgierens\">\n <img src=\"https://avatars.githubusercontent.com/u/4150500?v=4\" width=\"100;\" alt=\"andrewgierens\"/>\n <br />\n <sub><b>Andrew Gierens</b></sub>\n </a>\n </td>\n <td align=\"center\">\n <a href=\"https://github.com/ygerlach\">\n <img src=\"https://avatars.githubusercontent.com/u/100762533?v=4\" width=\"100;\" alt=\"ygerlach\"/>\n <br />\n <sub><b>Yannis Gerlach</b></sub>\n </a>\n </td></tr>\n</table>\n<!-- readme: contributors -end -->\n",
"bugtrack_url": null,
"license": "",
"summary": "A small package that wraps a few of the SEMS Portal apis",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/andrewgierens/sems_portal_api/issues",
"Homepage": "https://github.com/andrewgierens/sems_portal_api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b348df64248f4ee95daf2de22a83337dab11cd3146e5d9fef7ec3ae5eb6c488",
"md5": "e20562b2862cf2474e63d255a23ff9f4",
"sha256": "9aeac11ca8d1c4a9ab235c4eb01bbaf8ebe4101186ce921184476e05ecc7bb8d"
},
"downloads": -1,
"filename": "sems_portal_api-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e20562b2862cf2474e63d255a23ff9f4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 18491,
"upload_time": "2023-12-10T00:51:51",
"upload_time_iso_8601": "2023-12-10T00:51:51.385697Z",
"url": "https://files.pythonhosted.org/packages/6b/34/8df64248f4ee95daf2de22a83337dab11cd3146e5d9fef7ec3ae5eb6c488/sems_portal_api-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1b22f7ea586f0109b83b443a7e2eaed3eaa09c84ef1c7174e7ab64856454d619",
"md5": "e0b579d1c5c3f0f71b84b925b45165a8",
"sha256": "c7a3ffe6d71a4872ef2857c7a93303f29a5e1e486961f7da5fa74a7d03533eca"
},
"downloads": -1,
"filename": "sems_portal_api-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e0b579d1c5c3f0f71b84b925b45165a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 19565,
"upload_time": "2023-12-10T00:51:53",
"upload_time_iso_8601": "2023-12-10T00:51:53.029740Z",
"url": "https://files.pythonhosted.org/packages/1b/22/f7ea586f0109b83b443a7e2eaed3eaa09c84ef1c7174e7ab64856454d619/sems_portal_api-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-10 00:51:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andrewgierens",
"github_project": "sems_portal_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
"==",
"3.8.2"
]
]
}
],
"lcname": "sems-portal-api"
}
