Skip to main content

HomeSetup python library

Project description

HomeSetup Python Library - HSPyLib

Your mature python application

Tests License Release PyPi GitHub Gitter Donate

HSPyLib is a Python library that will elevate your experience to another level. It relies on well known principles as SOLID, DRY (Don't Repeat Yourself), KISS (Keep It Simple, Stupid) and YAGNI (You Ain’t Gonna Need It). It provides many frameworks and facilities to help you create mature python3 applications "PYCSNBASS" (Python Code Should Not Be A Simple Script).

HSPyLib is a part of the HomeSetup project.

Highlights

  • Easy installation.
  • Manager application that provides a helper to scaffold you applications.
  • Widgets application that provides running built-in and custom widgets.
  • Enhanced TUI helpers and input methods, to elevate you terminal UI applications.
  • Crud framework to help with databases, repositories and services.
  • HTTP Request helpers.
  • Python3 application framework.
  • HSPyLib widgets framework.
  • Enable Properties and AppConfigs using various syntax's like .properties, .ini and .yaml.
  • Well tested code and often pylint clean.
  • Gradle build system with many extensions.

A menu select example:

from hspylib.modules.cli.tui.extra.mselect import mselect

if __name__ == '__main__':
    it = [f"Item-{n}" for n in range(1, 21)]
    sel = mselect(it, max_rows=10)
    print(str(sel))

MenuSelect

A menu choose example:

from hspylib.modules.cli.tui.extra.mchoose import mchoose

if __name__ == '__main__':
    it = [f"Item-{n}" for n in range(1, 21)]
    sel = mchoose(it, max_rows=10)
    print(str(sel))

MenuChoose

A Dashboard example:

if __name__ == '__main__':
# @formatter:off
dashboard_items = MenuDashBoard.builder() \
    .item() \
        .icon(DashboardIcons.PLUS) \
        .tooltip('Add something') \
        .on_trigger(lambda: print('Add')) \
        .build() \
    .item() \
        .icon(DashboardIcons.MINUS) \
        .tooltip('Remove something') \
        .on_trigger(lambda: print('Del')) \
        .build() \
    .item() \
        .icon(DashboardIcons.EDIT) \
        .tooltip('Edit something') \
        .on_trigger(lambda: print('Edit')) \
        .build() \
    .item() \
        .icon(DashboardIcons.LIST) \
        .tooltip('List everything') \
        .on_trigger(lambda: print('List')) \
        .build() \
    .item() \
        .icon(DashboardIcons.DATABASE) \
        .tooltip('Database console') \
        .on_trigger(lambda: print('Database')) \
        .build() \
    .item() \
        .icon(DashboardIcons.EXIT) \
        .tooltip('Exit application') \
        .on_trigger(lambda: print('Exit')) \
        .build() \
    .build()
# @formatter:on
result = mdashboard(dashboard_items, 4)

MenuDashboard

A form input example

if __name__ == '__main__':
# @formatter:off
form_fields = MenuInput.builder() \
    .field() \
        .label('letters') \
        .validator(InputValidator.letters()) \
        .build() \
    .field() \
        .label('word') \
        .validator(InputValidator.words()) \
        .build() \
    .field() \
        .label('number') \
        .validator(InputValidator.numbers()) \
        .min_max_length(1, 2) \
        .build() \
    .field() \
        .label('masked') \
        .itype('masked') \
        .value('|##::##::## @@') \
        .build() \
    .field() \
        .label('selectable') \
        .itype('select') \
        .value('one|two|three') \
        .build() \
    .field() \
        .label('checkbox') \
        .itype('checkbox') \
    .build() \
    .field() \
        .label('password') \
        .itype('password') \
        .validator(InputValidator.anything()) \
        .min_max_length(4, 8) \
        .build() \
    .field() \
        .label('read-only') \
        .access_type('read-only') \
        .value('READ-ONLY') \
        .build() \
    .build()
# @formatter:on
result = minput(form_fields)
print(result.__dict__)

MenuInput

And many other cool features like repositories, Qt and CRUD helpers, etc...

Table of contents

Installation

Requirements

Operating Systems

  • Darwin
    • High Sierra and higher
  • Linux
    • Ubuntu 16 and higher
    • CentOS 7 and higher
    • Fedora 31 and higher

You may want to install HSPyLib on other OS's and it will probably work, but there are no guarantees that it WILL ACTUALLY WORK.

Required software

The following software are required:

  • Git (To clone the github repository)
  • Gradle (To build the HSPyLib project)
  • instantclient-basiclite-macos (To use oracle database repositories)

There are some python dependencies, but they will be automatically downloaded when the build runs.

PyPi

To install HSPyLib from PyPi issue the command:

# python3 -m pip install hspylib

To upgrade HSPyLib use the command:

# python3 -m pip install hspylib --upgrade

GitHub

To clone HSPyLib into your local machine issue the command:

# git clone https://github.com/yorevs/hspylib.git

Documentation

TBD

Contact

You can contact us using our Gitter community or using our Reddit.

Support HSPyLib

You can support HSPyLib by donating or coding. Fell free to contact me for details. When contributing with code change please take a look at our guidelines and code of conduct.

paypal

Links

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hspylib-0.11.5.tar.gz (83.2 kB view details)

Uploaded Source

Built Distribution

hspylib-0.11.5-py3-none-any.whl (150.2 kB view details)

Uploaded Python 3

File details

Details for the file hspylib-0.11.5.tar.gz.

File metadata

  • Download URL: hspylib-0.11.5.tar.gz
  • Upload date:
  • Size: 83.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for hspylib-0.11.5.tar.gz
Algorithm Hash digest
SHA256 2c0867229e7cd57d838f046507090dfa31f2645d0206d17f6f2d5bea81b29e36
MD5 b6dd95a840e9a4cca8e8c23566612771
BLAKE2b-256 4a83478a4cb6b48261bc0ff3ea6fc652f5aa10d716c4afb673e794c31e3f7a2f

See more details on using hashes here.

File details

Details for the file hspylib-0.11.5-py3-none-any.whl.

File metadata

  • Download URL: hspylib-0.11.5-py3-none-any.whl
  • Upload date:
  • Size: 150.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for hspylib-0.11.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7665316a78899d50df8135d77d9e1a4f7e2c78e353b74cbab9b52a2c95241552
MD5 d2407672647a45614aed5d1f2e1f1719
BLAKE2b-256 0b123d0ef8679c9fde92f6217be64f1517ab8031a741c7ed3c3e1efefab709f9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page