mirror of https://github.com/rootzoll/raspiblitz.git synced 2024-11-20 10:12:06 +01:00

History

frennkie 935cb44bc4 add BlitzPy v0.2		2020-05-23 12:52:22 +01:00
..
blitzpy	add write() to BlitzPy config Classes	2020-05-23 12:51:30 +01:00
dist	add BlitzPy v0.2	2020-05-23 12:52:22 +01:00
CHANGELOG.md	add write() to BlitzPy config Classes	2020-05-23 12:51:30 +01:00
LICENSE	BlitzPy initial add	2020-05-22 22:45:37 +01:00
Makefile	BlitzPy initial add	2020-05-22 22:45:37 +01:00
MANIFEST.in	BlitzPy initial add	2020-05-22 22:45:37 +01:00
README.md	add write() to BlitzPy config Classes	2020-05-23 12:51:30 +01:00
setup.cfg	BlitzPy initial add	2020-05-22 22:45:37 +01:00
setup.py	BlitzPy initial add	2020-05-22 22:45:37 +01:00

README.md

BlitzPy

BlitzPy is a part of the RaspiBlitz project and implements a few common use cases.

Installation

Prerequisite

None

Dependencies

None

Install BlitzPy

cd ~/raspiblitz/home.admin/BlitzPy
pip install dist/BlitzPy-0.1.0-py2.py3-none-any.whl
OR
sudo -H python -m pip install dist/BlitzPy-0.1.0-py2.py3-none-any.whl

or consider using a virtual environment

python3 -m venv --system-site-packages venv
source venv/bin/activate
pip install BlitzPy

Usage

Import and use..

from blitzpy import RaspiBlitzConfig
cfg = RaspiBlitzConfig()
cfg.reload()
print(cfg.hostname)
if cfg.run_behind_tor:
    print("using TOR!")

Changing values

In order to change the content of a setting the value attribute needs to be updated!

from blitzpy import RaspiBlitzConfig
cfg = RaspiBlitzConfig()
cfg.reload()
print(cfg.hostname)
cfg.hostname.value = "New-Hostname!"
print(cfg.hostname)

Exporting

Use cfg.write() to export file (will use default path - override with cfg.write(path="/tmp/foobar.conf").

from blitzpy import RaspiBlitzConfig
cfg = RaspiBlitzConfig()
cfg.reload()
cfg.rtl_web_interface.value = True
cfg.write()

License

MIT License