pazgas-power 0.0.5

A python wrapper for PazGas Power

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.