diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9bd43c4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,14 @@ +Copyright 2024 Juggalol Enterprises Worldwide + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated +documentation files (the “Software”), to deal in the Software without restriction, including without limitation the +rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit +persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 524710f..cc51081 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Configurator -`Configurator` is a Python package designed for efficient and standardized configuration management in your +`configurator` is a Python package designed for efficient and standardized configuration management in your applications. It uses a singleton pattern to ensure that configuration is loaded once and accessible throughout your application. It supports merging custom configurations, validation of required configurations, and ease of access through getter methods. @@ -17,13 +17,13 @@ through getter methods. You can install the package via pip: ```bash -pip install configurator +pip install --index-url https://git.juggalol.com/api/packages/juggalol/pypi/simple configurator ``` Or by cloning this repository and installing with: ```bash -git clone https://github.com/yourusername/configurator.git +git clone https://github.com/juggalol/configurator.git cd configurator pip install . ``` @@ -32,7 +32,7 @@ pip install . ### Initial Setup -To use `Configurator` in your application, you first need to load the configuration. This should typically be done once +To use `configurator` in your application, you first need to load the configuration. This should typically be done once at the start of your application, for instance, in the main entry point or the initial setup script. ```python diff --git a/setup.py b/setup.py index 59b263e..8171d7e 100644 --- a/setup.py +++ b/setup.py @@ -8,13 +8,13 @@ with open("requirements.txt", "r") as fh: setup( name="configurator", - version="0.1.0", + version="0.1.1", author="agathanonymous", author_email="agatha@juggalol.com", - description="A configuration management package", + description="A Python configuration management package", long_description=long_description, long_description_content_type="text/markdown", - url="https://git.juggalol.com/agatha/configurator", + url="https://git.juggalol.com/juggalol/configurator", packages=find_packages(), classifiers=[ "Programming Language :: Python :: 3",