# Python: MyLight Systems
[![GitHub Release][releases-shield]][releases]
[![Python Versions][python-versions-shield]][pypi]
![Project Stage][project-stage-shield]
![Project Maintenance][maintenance-shield]
[![License][license-shield]](.github/LICENSE.md)
[![Build Status][build-shield]][build]
[![Code Coverage][codecov-shield]][codecov]
Asynchronous Python client for MyLight Systems.
## About
This package allows you to fetch data from MyLight Systems.
This source code is based on the [airgradient-python](https://github.com/acesyde/python-mylight-systems-api-client) package.
## Installation
```bash
pip install mylightsystems-api-client
```
## Changelog & Releases
This repository keeps a change log using [GitHub's releases][releases]
functionality. The format of the log is based on
[Keep a Changelog][keepchangelog].
Releases are based on [Semantic Versioning][semver], and use the format
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
based on the following:
- `MAJOR`: Incompatible or major changes.
- `MINOR`: Backwards-compatible new features and enhancements.
- `PATCH`: Backwards-compatible bugfixes and package updates.
## Contributing
This is an active open-source project. We are always open to people who want to
use the code or contribute to it.
We've set up a separate document for our
[contribution guidelines](.github/CONTRIBUTING.md).
Thank you for being involved! :heart_eyes:
## Setting up development environment
This Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.
You need at least:
- Python 3.11+
- [Poetry][poetry-install]
- NodeJS 20+
To install all packages, including all development requirements:
```bash
npm install
poetry install
```
As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
```bash
poetry run pre-commit run --all-files
```
To run just the Python tests:
```bash
poetry run pytest
```
## Authors & contributors
The content is by [Pierre-Emmanuel Mercier][acesyde].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
[build-shield]: https://github.com/acesyde/python-mylight-systems-api-client/actions/workflows/tests.yaml/badge.svg
[build]: https://github.com/acesyde/python-mylight-systems-api-client/actions
[codecov-shield]: https://codecov.io/gh/acesyde/python-mylight-systems-api-client/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/acesyde/python-mylight-systems-api-client
[commits-shield]: https://img.shields.io/github/commit-activity/y/acesyde/python-mylight-systems-api-client.svg
[commits]: https://github.com/acesyde/python-mylight-systems-api-client/commits/master
[contributors]: https://github.com/acesyde/python-mylight-systems-api-client/graphs/contributors
[acesyde]: https://github.com/acesyde
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[license-shield]: https://img.shields.io/github/license/acesyde/python-mylight-systems-api-client.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
[poetry-install]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org
[pre-commit]: https://pre-commit.com/
[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg
[python-versions-shield]: https://img.shields.io/pypi/pyversions/mylightsystems-api-client
[releases-shield]: https://img.shields.io/github/release/acesyde/python-mylight-systems-api-client.svg
[releases]: https://github.com/acesyde/python-mylight-systems-api-client/releases
[semver]: http://semver.org/spec/v2.0.0.html
[pypi]: https://pypi.org/project/mylightsystems-api-client/
Raw data
{
"_id": null,
"home_page": "https://github.com/acesyde/python-mylight-systems-api-client",
"name": "mylightsystems",
"maintainer": "Pierre-Emmanuel Mercier",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "acesyde@gmail.com",
"keywords": "MyLight Systems, api, async, client",
"author": "Pierre-Emmanuel Mercier",
"author_email": "acesyde@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0d/bb/a106eca04a3f7a333196a647aef536ef6fb4e2e47bbb4ed3d2e4a5928f8c/mylightsystems-0.0.2.tar.gz",
"platform": null,
"description": "# Python: MyLight Systems\n\n[![GitHub Release][releases-shield]][releases]\n[![Python Versions][python-versions-shield]][pypi]\n![Project Stage][project-stage-shield]\n![Project Maintenance][maintenance-shield]\n[![License][license-shield]](.github/LICENSE.md)\n\n[![Build Status][build-shield]][build]\n[![Code Coverage][codecov-shield]][codecov]\n\nAsynchronous Python client for MyLight Systems.\n\n## About\n\nThis package allows you to fetch data from MyLight Systems.\n\nThis source code is based on the [airgradient-python](https://github.com/acesyde/python-mylight-systems-api-client) package.\n\n## Installation\n\n```bash\npip install mylightsystems-api-client\n```\n\n## Changelog & Releases\n\nThis repository keeps a change log using [GitHub's releases][releases]\nfunctionality. The format of the log is based on\n[Keep a Changelog][keepchangelog].\n\nReleases are based on [Semantic Versioning][semver], and use the format\nof `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented\nbased on the following:\n\n- `MAJOR`: Incompatible or major changes.\n- `MINOR`: Backwards-compatible new features and enhancements.\n- `PATCH`: Backwards-compatible bugfixes and package updates.\n\n## Contributing\n\nThis is an active open-source project. We are always open to people who want to\nuse the code or contribute to it.\n\nWe've set up a separate document for our\n[contribution guidelines](.github/CONTRIBUTING.md).\n\nThank you for being involved! :heart_eyes:\n\n## Setting up development environment\n\nThis Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.\n\nYou need at least:\n\n- Python 3.11+\n- [Poetry][poetry-install]\n- NodeJS 20+\n\nTo install all packages, including all development requirements:\n\n```bash\nnpm install\npoetry install\n```\n\nAs this repository uses the [pre-commit][pre-commit] framework, all changes\nare linted and tested with each commit. You can run all checks and tests\nmanually, using the following command:\n\n```bash\npoetry run pre-commit run --all-files\n```\n\nTo run just the Python tests:\n\n```bash\npoetry run pytest\n```\n\n## Authors & contributors\n\nThe content is by [Pierre-Emmanuel Mercier][acesyde].\n\nFor a full list of all authors and contributors,\ncheck [the contributor's page][contributors].\n\n[build-shield]: https://github.com/acesyde/python-mylight-systems-api-client/actions/workflows/tests.yaml/badge.svg\n[build]: https://github.com/acesyde/python-mylight-systems-api-client/actions\n[codecov-shield]: https://codecov.io/gh/acesyde/python-mylight-systems-api-client/branch/master/graph/badge.svg\n[codecov]: https://codecov.io/gh/acesyde/python-mylight-systems-api-client\n[commits-shield]: https://img.shields.io/github/commit-activity/y/acesyde/python-mylight-systems-api-client.svg\n[commits]: https://github.com/acesyde/python-mylight-systems-api-client/commits/master\n[contributors]: https://github.com/acesyde/python-mylight-systems-api-client/graphs/contributors\n[acesyde]: https://github.com/acesyde\n[keepchangelog]: http://keepachangelog.com/en/1.0.0/\n[license-shield]: https://img.shields.io/github/license/acesyde/python-mylight-systems-api-client.svg\n[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg\n[poetry-install]: https://python-poetry.org/docs/#installation\n[poetry]: https://python-poetry.org\n[pre-commit]: https://pre-commit.com/\n[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg\n[python-versions-shield]: https://img.shields.io/pypi/pyversions/mylightsystems-api-client\n[releases-shield]: https://img.shields.io/github/release/acesyde/python-mylight-systems-api-client.svg\n[releases]: https://github.com/acesyde/python-mylight-systems-api-client/releases\n[semver]: http://semver.org/spec/v2.0.0.html\n[pypi]: https://pypi.org/project/mylightsystems-api-client/\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Asynchronous Python client for MyLight Systems.",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/acesyde/python-mylight-systems-api-client/issues",
"Changelog": "https://github.com/acesyde/python-mylight-systems-api-client/releases",
"Documentation": "https://github.com/acesyde/python-mylight-systems-api-client",
"Homepage": "https://github.com/acesyde/python-mylight-systems-api-client",
"Repository": "https://github.com/acesyde/python-mylight-systems-api-client"
},
"split_keywords": [
"mylight systems",
" api",
" async",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40b81c19f228c01cc1ed05a45023d687435fd4918a582da5427a4dc9bb98e3c1",
"md5": "067f1f4913e607e3c4eb1c96d284f1c0",
"sha256": "32ed3b57267531026ad1d2f81901635f363d9b542694584822d8e32b49dd60d7"
},
"downloads": -1,
"filename": "mylightsystems-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "067f1f4913e607e3c4eb1c96d284f1c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 7912,
"upload_time": "2024-09-21T09:50:32",
"upload_time_iso_8601": "2024-09-21T09:50:32.413989Z",
"url": "https://files.pythonhosted.org/packages/40/b8/1c19f228c01cc1ed05a45023d687435fd4918a582da5427a4dc9bb98e3c1/mylightsystems-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0dbba106eca04a3f7a333196a647aef536ef6fb4e2e47bbb4ed3d2e4a5928f8c",
"md5": "cc82153396cd073270c61b418581f8de",
"sha256": "2f65b17b5db62834bffa29903fd27f84659d00ac64e6b01d5cdaef0c42a36e21"
},
"downloads": -1,
"filename": "mylightsystems-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "cc82153396cd073270c61b418581f8de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 8494,
"upload_time": "2024-09-21T09:50:33",
"upload_time_iso_8601": "2024-09-21T09:50:33.934134Z",
"url": "https://files.pythonhosted.org/packages/0d/bb/a106eca04a3f7a333196a647aef536ef6fb4e2e47bbb4ed3d2e4a5928f8c/mylightsystems-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 09:50:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "acesyde",
"github_project": "python-mylight-systems-api-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mylightsystems"
}
JSON
