| Name | pazgas-power JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | None |
| Summary | A python wrapper for PazGas Power |
| upload_time | 2024-11-05 16:26:47 |
| maintainer | None |
| docs_url | None |
| author | Guy Khmelnitsky |
| requires_python | <4.0,>=3.11 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pazgas-power - PazGas Power API Python wrapper
This would allow you to logon, fetch various data.
## Installation
To install, run:
```
pip3 install pazgas-power
```
## Usage Example
```python
from pazgas_power import PazGasPowerApi, CustomerData
api = PazGasPowerApi("123456", "055-555555")
# ^user_id^ ^phone^
customer_data: CustomerData = await api.login_and_get_customer_data()
print(customer_data)
```
## Technology and Resources
- [Python 3.11](https://www.python.org/downloads/release/python-3110/) - **pre-requisite**
- [Docker](https://www.docker.com/get-started) - **pre-requisite**
- [Docker Compose](https://docs.docker.com/compose/) - **pre-requisite**
- [Poetry](https://python-poetry.org/) - **pre-requisite**
- [Ruff](https://github.com/astral-sh/ruff)
*Please pay attention on **pre-requisites** resources that you must install/configure.*
## How to install, run and test
### Environment variables
*Use this section to explain each env variable available on your application*
Variable | Description | Available Values | Default Value | Required
--- | --- | --- | --- | ---
ENV | The application enviroment | `dev / test / qa / prod` | `dev` | Yes
PYTHONPATH | Provides guidance to the Python interpreter about where to find libraries and applications | [ref](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH) | `.` | Yes
*Note: When you run the install command (using docker or locally), a .env file will be created automatically based on [env.template](env.template)*
Command | Docker | Locally | Description
---- | ------- | ------- | -------
install | `make docker/install` | `make local/install` | to install
tests | `make docker/tests` | `make local/tests` | to run the tests with coverage
lint | `make docker/lint` | `make local/lint` | to run static code analysis using ruff
lint/fix | `make docker/lint/fix` | `make local/lint/fix` | to fix files using ruff
build image | `make docker/image/build` | - | to build the docker image
push image | `make docker/image/push` | - | to push the docker image
**Helpful commands**
*Please, check all available commands in the [Makefile](Makefile) for more information*.
## Logging
This project uses a simple way to configure the log with [logging.conf](logging.conf) to show the logs on the container output console.
## Settings
This project uses a simple way to manage the settings with [settings.conf](settings.conf) and [ConfigParser](https://docs.python.org/3/library/configparser.html) using a [config class](./src/config/settings.py).
Raw data
{
"_id": null,
"home_page": null,
"name": "pazgas-power",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Guy Khmelnitsky",
"author_email": "guykhmel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/61/dc/9ef9a0a596f27ba6b7eadca9ebd565a0b9b0f91c523797d537085bd1ac0e/pazgas_power-0.0.5.tar.gz",
"platform": null,
"description": "# pazgas-power - PazGas Power API Python wrapper\n\nThis would allow you to logon, fetch various data.\n\n## Installation\nTo install, run:\n```\npip3 install pazgas-power\n```\n\n## Usage Example\n```python\nfrom pazgas_power import PazGasPowerApi, CustomerData\n\napi = PazGasPowerApi(\"123456\", \"055-555555\")\n# ^user_id^ ^phone^\n\ncustomer_data: CustomerData = await api.login_and_get_customer_data()\nprint(customer_data)\n```\n\n## Technology and Resources\n\n- [Python 3.11](https://www.python.org/downloads/release/python-3110/) - **pre-requisite**\n- [Docker](https://www.docker.com/get-started) - **pre-requisite**\n- [Docker Compose](https://docs.docker.com/compose/) - **pre-requisite**\n- [Poetry](https://python-poetry.org/) - **pre-requisite**\n- [Ruff](https://github.com/astral-sh/ruff)\n\n*Please pay attention on **pre-requisites** resources that you must install/configure.*\n\n## How to install, run and test\n\n### Environment variables\n\n*Use this section to explain each env variable available on your application*\n\nVariable | Description | Available Values | Default Value | Required\n--- | --- | --- | --- | ---\nENV | The application enviroment | `dev / test / qa / prod` | `dev` | Yes\nPYTHONPATH | Provides guidance to the Python interpreter about where to find libraries and applications | [ref](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH) | `.` | Yes\n\n*Note: When you run the install command (using docker or locally), a .env file will be created automatically based on [env.template](env.template)*\n\nCommand | Docker | Locally | Description\n---- | ------- | ------- | -------\ninstall | `make docker/install` | `make local/install` | to install\ntests | `make docker/tests` | `make local/tests` | to run the tests with coverage\nlint | `make docker/lint` | `make local/lint` | to run static code analysis using ruff\nlint/fix | `make docker/lint/fix` | `make local/lint/fix` | to fix files using ruff\nbuild image | `make docker/image/build` | - | to build the docker image\npush image | `make docker/image/push` | - | to push the docker image\n\n**Helpful commands**\n\n*Please, check all available commands in the [Makefile](Makefile) for more information*.\n\n## Logging\n\nThis project uses a simple way to configure the log with [logging.conf](logging.conf) to show the logs on the container output console.\n\n## Settings\n\nThis project uses a simple way to manage the settings with [settings.conf](settings.conf) and [ConfigParser](https://docs.python.org/3/library/configparser.html) using a [config class](./src/config/settings.py).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python wrapper for PazGas Power",
"version": "0.0.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01b38501515bcc9ea651442762ef9573fe0fd71dabf7c96c2d8942f0750eaa98",
"md5": "3b3ccaa3c3eef9878ce8b0942a72ebc3",
"sha256": "edeaa9a421fb73ede6845af60e7d496e318715fb50ae238b120c23a361c89309"
},
"downloads": -1,
"filename": "pazgas_power-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b3ccaa3c3eef9878ce8b0942a72ebc3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 13002,
"upload_time": "2024-11-05T16:26:45",
"upload_time_iso_8601": "2024-11-05T16:26:45.566029Z",
"url": "https://files.pythonhosted.org/packages/01/b3/8501515bcc9ea651442762ef9573fe0fd71dabf7c96c2d8942f0750eaa98/pazgas_power-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61dc9ef9a0a596f27ba6b7eadca9ebd565a0b9b0f91c523797d537085bd1ac0e",
"md5": "90e282fe7d631ef5a59ef2bb62baaae4",
"sha256": "9d6424e53f9ddf8c304bb9125afae28544e27727b8ca40cf11b1a615f0adae27"
},
"downloads": -1,
"filename": "pazgas_power-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "90e282fe7d631ef5a59ef2bb62baaae4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 10903,
"upload_time": "2024-11-05T16:26:47",
"upload_time_iso_8601": "2024-11-05T16:26:47.236094Z",
"url": "https://files.pythonhosted.org/packages/61/dc/9ef9a0a596f27ba6b7eadca9ebd565a0b9b0f91c523797d537085bd1ac0e/pazgas_power-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 16:26:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pazgas-power"
}
