polite-config 1.0.0__tar.gz

polite_config-1.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-2018 Mathew Bernard Robert Topper
+
+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.

polite_config-1.0.0/LICENSES/APPDIRS_LICENSE.txt

@@ -0,0 +1,23 @@
+# This is the MIT license
+
+Copyright (c) 2010 ActiveState Software Inc.
+
+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.
+

polite_config-1.0.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: polite-config
+Version: 1.0.0
+Summary: Easy functions for paths, logging and configuration files
+Home-page: https://github.com/DTOcean/dtocean
+License: MIT
+Author: Mathew Toppper
+Author-email: damm_horse@yahoo.co.uk
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: configobj (>=5.0.9,<6.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Project-URL: Bug Tracker, https://github.com/DTOcean/dtocean/issues
+Project-URL: Repository, https://github.com/DTOcean/dtocean
+Description-Content-Type: text/markdown
+
+# polite-config
+
+Easy functions for paths, logging and configuration files.
+
+## Installation
+
+Installation and development of polite-config uses the [Poetry](https://python-poetry.org/)
+dependency manager. Poetry must be installed and available on the command line.
+
+To install:
+
+```console
+poetry install
+```
+
+## Tests
+
+A test suite is provided with the source code that uses [pytest](https://docs.pytest.org).
+
+Install the testing dependencies:
+
+```console
+poetry install --with test
+```
+
+Run the tests:
+
+```console
+poetry run pytest
+```
+
+## Usage
+
+An example of setting up [logging](https://docs.python.org/3/library/logging.html)
+using a user-specific [yaml configuration file](https://docs.python.org/3/howto/logging.html#configuring-logging).
+
+Copy the default logging file from the module source code to the user's data
+directory (`C:\Users\<USERNAME>\AppData\Roaming\DTOcean\polite`):
+
+```pycon
+>>> from polite_config.paths import (DirectoryMap, ModPath, UserDataPath)
+
+>>> objdir = ModPath("polite", "config")
+>>> datadir = UserDataPath("polite", "DTOcean")
+>>> dirmap = DirectoryMap(datadir, objdir)
+>>> dirmap.copy_file("logging.yaml", overwrite=True)
+>>> datadir.isfile("logging.yaml")
+True
+```
+
+Use the copied configuration file to set up logging:
+
+```pycon
+>>> from polite_config.configuration import Logger
+
+>>> log = Logger(datadir)
+>>> log_config_dict = log.read()
+>>> log.configure_logger(log_config_dict)
+>>> logger = log.add_named_logger("polite")
+>>> logger.info("Hello World")
+INFO - polite - Hello World
+```
+
+Note that classes such as `ModPath` and `UserDataPath` are subclasses of
+`pathlib.Path`.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to
+discuss what you would like to change.
+
+See [this blog post](https://www.dataonlygreater.com/blog/post/dtocean-development-change-management/)
+for information regarding development of the DTOcean ecosystem.
+
+Please make sure to update tests as appropriate.
+
+## Credits
+
+This package was initially created as part of the [EU DTOcean project](https://cordis.europa.eu/project/id/608597)
+by Mathew Topper at [TECNALIA](https://www.tecnalia.com).
+
+It is now maintained by Mathew Topper at [Data Only Greater](https://www.dataonlygreater.com/).
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+

polite_config-1.0.0/README.md

@@ -0,0 +1,86 @@
+# polite-config
+
+Easy functions for paths, logging and configuration files.
+
+## Installation
+
+Installation and development of polite-config uses the [Poetry](https://python-poetry.org/)
+dependency manager. Poetry must be installed and available on the command line.
+
+To install:
+
+```console
+poetry install
+```
+
+## Tests
+
+A test suite is provided with the source code that uses [pytest](https://docs.pytest.org).
+
+Install the testing dependencies:
+
+```console
+poetry install --with test
+```
+
+Run the tests:
+
+```console
+poetry run pytest
+```
+
+## Usage
+
+An example of setting up [logging](https://docs.python.org/3/library/logging.html)
+using a user-specific [yaml configuration file](https://docs.python.org/3/howto/logging.html#configuring-logging).
+
+Copy the default logging file from the module source code to the user's data
+directory (`C:\Users\<USERNAME>\AppData\Roaming\DTOcean\polite`):
+
+```pycon
+>>> from polite_config.paths import (DirectoryMap, ModPath, UserDataPath)
+
+>>> objdir = ModPath("polite", "config")
+>>> datadir = UserDataPath("polite", "DTOcean")
+>>> dirmap = DirectoryMap(datadir, objdir)
+>>> dirmap.copy_file("logging.yaml", overwrite=True)
+>>> datadir.isfile("logging.yaml")
+True
+```
+
+Use the copied configuration file to set up logging:
+
+```pycon
+>>> from polite_config.configuration import Logger
+
+>>> log = Logger(datadir)
+>>> log_config_dict = log.read()
+>>> log.configure_logger(log_config_dict)
+>>> logger = log.add_named_logger("polite")
+>>> logger.info("Hello World")
+INFO - polite - Hello World
+```
+
+Note that classes such as `ModPath` and `UserDataPath` are subclasses of
+`pathlib.Path`.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to
+discuss what you would like to change.
+
+See [this blog post](https://www.dataonlygreater.com/blog/post/dtocean-development-change-management/)
+for information regarding development of the DTOcean ecosystem.
+
+Please make sure to update tests as appropriate.
+
+## Credits
+
+This package was initially created as part of the [EU DTOcean project](https://cordis.europa.eu/project/id/608597)
+by Mathew Topper at [TECNALIA](https://www.tecnalia.com).
+
+It is now maintained by Mathew Topper at [Data Only Greater](https://www.dataonlygreater.com/).
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

polite_config-1.0.0/pyproject.toml

@@ -0,0 +1,46 @@
+[tool.poetry]
+name = "polite-config"
+version = "1.0.0"
+authors = ["Mathew Toppper <damm_horse@yahoo.co.uk>"]
+description = "Easy functions for paths, logging and configuration files"
+readme = "README.md"
+license = "MIT"
+repository = "https://github.com/DTOcean/dtocean"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+packages = [{include = "polite_config", from="src"}]
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/DTOcean/dtocean/issues"
+
+[tool.poetry.group.test]
+optional = true
+
+[tool.poetry.dependencies]
+python = "^3.13"
+configobj = "^5.0.9"
+pyyaml = "^6.0.2"
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.3.4"
+pytest-cov = "^6.0.0"
+pytest-mock = "^3.14.0"
+
+[tool.coverage.run]
+branch = true
+omit = [
+    "src/polite_config/appdirs.py" # omit appdirs as developed externally
+]
+source = [
+    "src"
+]
+
+[tool.ruff]
+line-length = 80
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

polite_config-1.0.0/src/polite_config/__init__.py

@@ -0,0 +1 @@
+__all__ = ["abc", "configuration", "paths"]