Bezeq API wrapper for my-bezeq interface
Project description
py-my-bezeq - Bezeq (MyBezeq) API Python wrapper
This would allow you to logon, fetch various data.
Installation
To install, run:
pip3 install py-my-bezeq
Usage example
from my_bezeq import MyBezeqAPI
api = MyBezeqAPI("1234", "password")
await api.login()
print("Logged in")
print(await api.get_dashboard_tab())
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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file py_my_bezeq-0.0.4.tar.gz
.
File metadata
- Download URL: py_my_bezeq-0.0.4.tar.gz
- Upload date:
- Size: 13.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.0 CPython/3.11.10 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9b8e161890fa4032646550ac3a6b86f9ef586dd68d2dc00a2f128a0bd99a977 |
|
MD5 | 741342fa62007ccd551f6d33e52f9ed6 |
|
BLAKE2b-256 | ff9eced4eaef1fda5447f1ba75a4f4e03ec862a792ff7fa0f7f0b620432a6eb5 |
File details
Details for the file py_my_bezeq-0.0.4-py3-none-any.whl
.
File metadata
- Download URL: py_my_bezeq-0.0.4-py3-none-any.whl
- Upload date:
- Size: 18.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.0 CPython/3.11.10 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bbb8901209670744fa78857d75a9469f2b81d98a90683445faeef203d3dc623 |
|
MD5 | 14b83e0ec5fc1a843476695e199091de |
|
BLAKE2b-256 | 5bf21f8746a93c28a140ae4c7ef07df2ef4f79cd59b123c8354bc49efe10bf79 |