Skip to content

Latest commit

 

History

History
134 lines (97 loc) · 7.25 KB

README.rst

File metadata and controls

134 lines (97 loc) · 7.25 KB

pyApp - A python application framework

Let us handle the boring stuff!

Docs ReadTheDocs
Build Dependabot Status
Quality Maintainability Security Test Coverage Once you go Black...
Package Latest Version https://img.shields.io/pypi/pyversions/pyapp https://img.shields.io/pypi/l/pyapp PyPI - Wheel

pyApp takes care of the boring boilerplate code for building a CLI, managing settings and much more so you can focus on your application logic.

So what does pyApp handle?

  • Configuration - Loading, merging your settings from different sources
    • Python modules
    • File and HTTP(S) endpoints for JSON and YAML files.
  • Instance Factories - Configuration of plugins, database connections, or just implementations of an ABC. Leveraging settings to make setup of your application easy and reduce coupling.
  • Dependency Injection - Easy to use dependency injection without complicated setup.
  • Checks - A framework for checking settings are correct and environment is operating correctly (your ops team will love you)?
  • Extensions - Extend the basic framework with extensions. Provides deterministic startup, extension of the CLI and the ability to register checks and extension specific default settings.
  • Application - Provides a extensible and simple CLI interface for running commands (including async), comes with built-in commands to execute check, setting and extension reports.
  • Logging - Initialise and apply sane logging defaults.
  • Highly tested and ready for production use.

Extensions

In Beta

In development

Coming soon

  • 📨 AMQP Messaging - Messaging extension for AMQP (RabbitMQ)

Contributions

Contributions are most welcome, be it in the form of a extension and factories for your favourite service client of bug reports, feature enhancements.

The core of pyApp is intended to remain simple and only provide required features with extensions providing optional more specific functionality.