Skip to main content

pyapputil

https://travis-ci.org/cseelye/pyapputil.svg?branch=master https://badge.fury.io/py/pyapputil.svg

Python module to simplify building CLI applications. Includes simple helpers for building an app, validating arguments, configfiles/default values, logging, global exception catching, privilege escalation, signal handling, time/timezones, multithreading…

Currently python 2.7 compatible, py3 in progress…

Documentation in progress…

appframework

appconfig

This module presents configuration values combined from defaults, user config, and environment variables.

To get a configuration variable named some_value:

from pyapputil.appconfig import appconfig
appconfig["some_value"]

The default values are stored in appdefaults.py in the application’s root directory. This is a pure python file that gets imported, so you it can be anything from a list of variables/values to any arbitrary code you need to set up your default values.

The user can optionally provide a userconfig.yml file to override the defaults. This is a text YAML file that gets loaded after appdefaults.py, and any values in this file will override values from appdefautls. If the user wants to override a default named some_var, they can simply add an entry to userconfig.yml like this: some_value: 123

The user can optionally export environment variables to override the defaults or user config. The prefix used for environment variables is set in appdefaults.py. If the prefix is set to “MYAPP_” and the user wan’t to override a config var named some_value, they could override it with an environment varible like this:

export MYAPP_SOME_VALUE=123

argutil

This is a forked version of python’s argparse, that is integrated with appconfig so that command line arguments can automatically set default values from appconfig, and the help display will show the default value as well as the name of the ENV variable that can be used to override it.

typeutil

Collection of type validators that can be used with argparse/argutil, and decorators and util functions for using the same validators on functions

exceptutil

logutil

shellutil

threadutil

Metadata

Release files for pyapputil 1.0.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyapputil 1.0.26
File Size Uploaded Provenance
pyapputil-1.0.26.tar.gz 45.9 kB Without provenance Details

Release files / pyapputil-1.0.26.tar.gz

Download URL pyapputil-1.0.26.tar.gz
Size 45.9 kB
Tags Source
SHA-256 checksum
How to use checksums
6a22f444fde2fec3d02d1877906bd9c19d0c05c5f4e3ee1aed2af29c5d5f369d
BLAKE2b-256 checksum
How to use checksums
461e323e6b67b8f4985dfb098a446f0ee3b19f22c33a0267f12228a4ebc390b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pyapputil 1.0.26

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page