Skip to main content

A Python library for common features in application development.

Project description

dtPyAppFramework

License

dtPyAppFramework is a Python library designed to streamline the development of Python applications by providing common features and abstractions. It promotes good practices, modular design, and ease of use.

Features

  • Singleton Management: Simplify the use of singleton classes by automating initialisation with predefined parameters.
  • Settings and Configuration: Manage application settings and configurations effortlessly.
  • Secrets Management: Securely handle secrets and credentials using local or cloud-based stores like AWS Secrets Manager and Asure KeyVault.
  • Application Initialisation: Quickly initialise your Python applications with the AbstractApp class, which takes care of common initialisation tasks.
  • Process Management: Use the ProcessManager for efficient process handling in your applications.

Installation

pip install dtPyAppFramework

Getting Started

AbstractApp Class

The AbstractApp class serves as a base class for creating Python applications. It handles common initialisation tasks and provides a structure for defining command-line arguments and the main application logic.

To create a simple Python application using dtPyAppFramework:

from dtPyAppFramework.application import AbstractApp
from dtPyAppFramework import settings

import logging

class MyApplication(AbstractApp):

    def define_args(self, arg_parser):
        # Define your command-line arguments here
        return

    def main(self, args):
        logging.info("Running your code")
        ## Place you own code here that you wish to run
        
# Initialise and run the application
MyApplication(description="Simple App", version="1.0", short_name="simple_app",
          full_name="Simple Application", console_app=True).run()

Features

Now lets take some time to go over the various features that makes dtPyAppFramework such a power library to base your Python projects of.

Logging

dtPyAppFramework offers flexible logging capabilities, allowing you to configure and manage logs easily.
In addition it offers some pretty cool logging capabilities straight out of the door which requires no setup from you.

Configuration Files

Easily read and manage configuration settings from configurations files.
Configuration files can be set for a specific user or for any user of the application.

Secrets Management

Securely store and retrieve sensitive information with encryption and best practices.
You can store secrets for a specific user or make secrets available to all users of the application.
In addition, you can use the AWS Secrets Management seamlessly within the application alongside the in-built secrets store.

Command Line Arguments

Effortlessly parse and manage command line arguments with support for defining options and accessing them in your code.

Application Directories

Access common resource paths like user storage directories.

Resource Manager

A robust Resource Manager, which is a singleton class named ResourceManager.

License

This project is licensed under the MIT License.

Contact

If you have any questions, bug reports, or feature requests, feel free to contact us.

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

dtpyappframework-1.4.3.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

dtPyAppFramework-1.4.3-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

Details for the file dtpyappframework-1.4.3.tar.gz.

File metadata

  • Download URL: dtpyappframework-1.4.3.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for dtpyappframework-1.4.3.tar.gz
Algorithm Hash digest
SHA256 323d8a020830133ee77b2075c6778cd19982c8e29b76fdbd9dd72f2bcb3c6ac8
MD5 560a2bcc456d487d6ffe9b1f68ddd807
BLAKE2b-256 2e77ea74c7e6ec343693967bf676d39f30a1a49e33c67e051789d6451c243165

See more details on using hashes here.

File details

Details for the file dtPyAppFramework-1.4.3-py3-none-any.whl.

File metadata

File hashes

Hashes for dtPyAppFramework-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c1fb2e87f012f21a8ef3577bd5e85b99c66c97bbbae700b6b99cad799797a257
MD5 0bf6703f15e1f903b1853af4e2435eb6
BLAKE2b-256 bd39a396fcb499760ba92fd943c378028cd6b167ce16d7853c28c09ab4854571

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