Package: application-properties
Library Package: application_propertiesProjectQualityCommunityMaintainersTheapplication_propertiespackage was born out of necessity.
During the creation of thePyMarkdownproject,
there was a distinct need for a configuration subsystem that was able to handle more
complex configuration scenarios.Theapplication_propertieslibrary has the following advnatages:Thoroughly testedThe project currently has over 65 tests and coverage percentages over 99%.Simple... With ExamplesThe 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 RequiredThe 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 AwareBy 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, theApplicationPropertiesFacadeobject can be used to restrict access
to only those properties that exist under a given hierarchy.Command Line AwareTheset_manual_propertyfunction allows for one or more individual properties to be
supplied by the command line.ExtensibleThe 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 cornerRequirementsThis project required Python 3.8 or later to function.Installationpipinstallapplication_propertiesHow To Use This PackageThe primary goal of this package is to provide a simple, easy to use interface
to access properties within a Python script or program.  It is our contention
that 80% or more of general usage of such a package will be focused on two
elements:loading a group of properties from a file that is properly formatted
for a given formataccessing a specific string property, possibly with a default, from the that
property storeExamplesFor concrete examples that show the power of this library package, please consult
theExamples Document.  If you come up with a normal example
of how to use our package that we have missed, or come up with a novel example of
how to use our package, please file an issue using the process below and let us
know. From our experience, one example can often paint a picture of how to use our
project that is difficult to explain clearly with just words.Issues and Future PlansIf you would like to report an issue with the library or the documentation, please
file an issueusing GitHub.
Please remember to fill in as much information as possible including a good, repeatable
pattern for reproducing the issue.  Do not overflow us with too much information,
but provide us with enough information to make the problem evident to us.If you would like to us to implement a feature that you believe is important, please
file an issueusing GitHubthat includes what you want to add, why you want to add it, and why it is important
to you, and how you think it will help others.  We truly want to listen to what
you see as a good feature, so please do not be upset if we say "no" or "let me
think about it".Please note that the issue you file will usually be the start of a conversation,
so be ready for more questions.  If you have any Python developer skills, please
mention that as well.  The conversations about "hey, can you..." is a lot different
than "if I do... can I add it to the project?".When Did Things Change?The changelog for this project is maintainedat this location.Still Have Questions?If you still have questions, please consult ourFrequently Asked Questionsdocument.Instructions For ContributingDeveloper notes on various topics are kept in the theDeveloper Notesdocument.If you attempting to contribute something to this project,
please follow the steps outlined in theCONTRIBUTING.mdfile.