A simple, easy to use, unified manner of accessing program properties.
Project description
application_properties
The application_properties
package was born out of necessity.
During the creation of the PyMarkdown
project, there was a distinct need for a configuration subsystem that was able to
handle more complex configuration schemas.
The application_properties
library has the following advnatages:
- Thoroughly tested
- The project currently has over 65 tests and coverage percentages over 99%.
- Simple... With Examples
- The package was created with the intention of being as easy to use as possbile.
- To that extent, there are 4 basic usage examples and over 10 advanced usage examples.
- Complex When Required
- The default is simplicity, but the package can step up when required to do so.
- Any actions outside of the simple scenario of getting an optional string value should be relatively easy to request of the package API.
- Hierarchically Aware
- By default, uses the
.
character in the property names to define levels of hierarchy. - Hierarchy levels can be used to find only those properties that exist under a given hierarchy.
- If desired, the
ApplicationPropertiesFacade
object can be used to restrict access to only those properties that exist under a given hierarchy.
- By default, uses the
- Command Line Aware
- The
set_manual_property
function allows for one or more individual properties to be supplied by the command line.
- The
- Extensible
- The loading of the properties is separate from access to the values for those properties.
- Due to the separation of the loading and accessing parts of the library,
custom loading classes can be added with ease.
- Current loading classes include loaders for Json files, with Simple Property files right around the corner
Requirements
This project required Python 3.8 or later to function.
Installation
pip install app_prop
API Documentation
The full documentation on the API is available in the API document. As that document is rather dry, more information is provided in the way of examples in the How To Use This Package section of the home page.
How To Use, And Other Stuff
For more information on this library please consult the various other section on the home page.
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
Built Distribution
Hashes for application_properties-0.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbb1a85fa993bb3b320b64fbe3f2149f35bd2a036c4712f436e478614530d7dc |
|
MD5 | ae5ce137bddaaee55b0b53ab47c7487c |
|
BLAKE2b-256 | 8c5432d1a43009430d237aa91a0989de014af6624e935b8abda99ac3378c19c8 |
Hashes for application_properties-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cc968f1b288ce36429bc93183cee2d26777e4a1d8c099fe8e3909d89ca065c7 |
|
MD5 | a088666158802f4e16fbad641a728c30 |
|
BLAKE2b-256 | b59318141345ec84952f05d729a4a0a92d80b6c8a10ea80eef499b1b394ae29e |