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
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 - pre-requisite
- Docker - pre-requisite
- Docker Compose - pre-requisite
- Poetry - pre-requisite
- 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 | . |
Yes |
Note: When you run the install command (using docker or locally), a .env file will be created automatically based on 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 for more information.
Logging
This project uses a simple way to configure the log with 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 and ConfigParser using a config class.
Metadata
Release files for pazgas-power 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pazgas_power-0.0.5.tar.gz | 10.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pazgas_power-0.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.9 kB
Release files / pazgas_power-0.0.5.tar.gz
| Download URL | pazgas_power-0.0.5.tar.gz |
|---|---|
| Size | 10.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d6424e53f9ddf8c304bb9125afae28544e27727b8ca40cf11b1a615f0adae27
|
|
BLAKE2b-256 checksum How to use checksums |
61dc9ef9a0a596f27ba6b7eadca9ebd565a0b9b0f91c523797d537085bd1ac0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.0 CPython/3.11.10 Linux/6.5.0-1025-azure
|
Release files / pazgas_power-0.0.5-py3-none-any.whl
| Download URL | pazgas_power-0.0.5-py3-none-any.whl |
|---|---|
| Size | 13.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
edeaa9a421fb73ede6845af60e7d496e318715fb50ae238b120c23a361c89309
|
|
BLAKE2b-256 checksum How to use checksums |
01b38501515bcc9ea651442762ef9573fe0fd71dabf7c96c2d8942f0750eaa98
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.0 CPython/3.11.10 Linux/6.5.0-1025-azure
|