plaster_yaml 1.0.0__tar.gz

plaster_yaml-1.0.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+## Version 0.2.0 - 2021-05-02
+
+* Implementation get_wsgi_app_settings for the Loader
+
+## Version 0.1.1 - 2021-04-26
+
+* Fix default logging
+
+## Version 0.1.0 - 2021-04-26
+
+* Initial Release

plaster_yaml-1.0.0/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2021, Guillaume Gauvrit and Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

plaster_yaml-1.0.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.1
+Name: plaster_yaml
+Version: 1.0.0
+Summary: A plaster plugin to configure pyramid app with Yaml
+Home-page: https://github.com/mardiros/plaster-yaml
+License: BSD-derived
+Author: Guillaume Gauvrit
+Author-email: guillaume@gauvr.it
+Requires-Python: >=3.8,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
+Requires-Dist: plaster (>=1.0,<2.0)
+Project-URL: Repository, https://github.com/mardiros/plaster-yaml
+Description-Content-Type: text/markdown
+
+# plaster-yaml
+
+## Introduction
+
+By default, Pyramid uses a PasteDeploy (.ini) file format for its
+configuration.
+
+When the `plaster-yaml` plugin is used, Pyramid applications are
+instead configured with a YAML configuration file.
+
+For example:
+
+```
+pserve development.yaml
+```
+
+## Installation
+
+## With poetry
+
+```
+poetry add plaster-yaml
+```
+
+## With pip
+
+```
+pip install plaster-yaml
+```
+
+## Usage
+
+The `plaster-yaml` plugin must be "registered".  This is done by
+configuring a Python package "entry point" using the packaging tool of
+your choice.  How this is done depends on the packaging tool.
+Examples are given below.
+
+When developing, using an "editable" install that executes your
+unpackaged code, after changing your package's configuration your
+packaging tool must be run in order to finalize the registration.
+Examples are given below.
+
+No special steps must be taken after configuring a entry point and
+(correctly) packaging your project.  The `plaster-yaml` plugin is
+registered when your project's package is installed.
+
+## With poetry
+
+Plugin registration is configured in your `pyproject.toml`, as
+follows:
+
+```
+[tool.poetry.plugins."paste.app_factory"]
+main = "<PATH_TO_MODULE_CONTAINING_MAIN>:main"
+
+[tool.poetry.plugins."plaster.loader_factory"]
+"file+yaml" = "plaster_yaml:Loader"
+```
+
+When developing, run `poetry install` to register your plugin after
+adding the above to your `pyproject.toml`.
+
+## With setuptools
+
+When developing, run `pip install -e .` to register your plugin after
+using either of approaches below.
+
+### With `pyproject.toml` and a `setuptools` `build` back-end
+
+This is the preferred method.
+
+Plugin registration may be configured in your `pyproject.toml`, as
+follows:
+
+```
+[project.entry-points.'paste.app_factory']
+main = '<my_app>:main']
+[project.entry-points.'plaster.loader_factory']
+yaml = 'plaster_yaml:Loader'
+```
+
+### With `setup.py`
+
+This method is generally obsolete, but it can be used when the
+`[project.entry-points]` table is declared "dynamic".  However, this
+method must be used when the deprecated `python setup.py ...`
+command is the package building method.
+
+Plugin registration may be configured in your `setup.py`, as
+follows:
+
+```
+setup(
+    ...,
+    entry_points={
+     'paste.app_factory': ['main = <my_app>:main'],
+     'plaster.loader_factory': ['yaml = plaster_yaml:Loader'],
+     ...
+    },
+)
+```
+
+## Troubleshooting
+
+The following exception means that you did not successfully register
+the `plaster-yaml` plugin:
+
+```
+plaster.exceptions.LoaderNotFound: Could not find a matching loader for the scheme "file+yaml", protocol "wsgi".
+```
+
+Read the relevant "Usage" sub-section, above, to find out how to
+register it properly.
+

plaster_yaml-1.0.0/README.md

@@ -0,0 +1,113 @@
+# plaster-yaml
+
+## Introduction
+
+By default, Pyramid uses a PasteDeploy (.ini) file format for its
+configuration.
+
+When the `plaster-yaml` plugin is used, Pyramid applications are
+instead configured with a YAML configuration file.
+
+For example:
+
+```
+pserve development.yaml
+```
+
+## Installation
+
+## With poetry
+
+```
+poetry add plaster-yaml
+```
+
+## With pip
+
+```
+pip install plaster-yaml
+```
+
+## Usage
+
+The `plaster-yaml` plugin must be "registered".  This is done by
+configuring a Python package "entry point" using the packaging tool of
+your choice.  How this is done depends on the packaging tool.
+Examples are given below.
+
+When developing, using an "editable" install that executes your
+unpackaged code, after changing your package's configuration your
+packaging tool must be run in order to finalize the registration.
+Examples are given below.
+
+No special steps must be taken after configuring a entry point and
+(correctly) packaging your project.  The `plaster-yaml` plugin is
+registered when your project's package is installed.
+
+## With poetry
+
+Plugin registration is configured in your `pyproject.toml`, as
+follows:
+
+```
+[tool.poetry.plugins."paste.app_factory"]
+main = "<PATH_TO_MODULE_CONTAINING_MAIN>:main"
+
+[tool.poetry.plugins."plaster.loader_factory"]
+"file+yaml" = "plaster_yaml:Loader"
+```
+
+When developing, run `poetry install` to register your plugin after
+adding the above to your `pyproject.toml`.
+
+## With setuptools
+
+When developing, run `pip install -e .` to register your plugin after
+using either of approaches below.
+
+### With `pyproject.toml` and a `setuptools` `build` back-end
+
+This is the preferred method.
+
+Plugin registration may be configured in your `pyproject.toml`, as
+follows:
+
+```
+[project.entry-points.'paste.app_factory']
+main = '<my_app>:main']
+[project.entry-points.'plaster.loader_factory']
+yaml = 'plaster_yaml:Loader'
+```
+
+### With `setup.py`
+
+This method is generally obsolete, but it can be used when the
+`[project.entry-points]` table is declared "dynamic".  However, this
+method must be used when the deprecated `python setup.py ...`
+command is the package building method.
+
+Plugin registration may be configured in your `setup.py`, as
+follows:
+
+```
+setup(
+    ...,
+    entry_points={
+     'paste.app_factory': ['main = <my_app>:main'],
+     'plaster.loader_factory': ['yaml = plaster_yaml:Loader'],
+     ...
+    },
+)
+```
+
+## Troubleshooting
+
+The following exception means that you did not successfully register
+the `plaster-yaml` plugin:
+
+```
+plaster.exceptions.LoaderNotFound: Could not find a matching loader for the scheme "file+yaml", protocol "wsgi".
+```
+
+Read the relevant "Usage" sub-section, above, to find out how to
+register it properly.

plaster_yaml-1.0.0/pyproject.toml

@@ -0,0 +1,30 @@
+[tool.poetry]
+name = "plaster_yaml"
+version = "1.0.0"
+description = "A plaster plugin to configure pyramid app with Yaml"
+readme = "README.md"
+authors = ["Guillaume Gauvrit <guillaume@gauvr.it>"]
+homepage = "https://github.com/mardiros/plaster-yaml"
+repository = "https://github.com/mardiros/plaster-yaml"
+include = ["CHANGELOG.md"]
+license = "BSD-derived"
+
+[tool.poetry.dependencies]
+python = "^3.8"
+plaster = "^1.0"
+# Upgraded PyYAML from ^5.4 due to: https://github.com/yaml/pyyaml/issues/601
+PyYAML = "^6.0.1"
+
+[tool.poetry.dev-dependencies]
+black = "^24.3.0"
+isort = "^5.13.2"
+# Tests
+gunicorn = "^20.1.0"
+PasteDeploy = "^2.1.1"
+pytest = "^6.2.5"
+waitress = "^2.0.0"
+pyramid-helloworld = "^1.1.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

plaster_yaml-1.0.0/src/plaster_yaml/__init__.py

@@ -0,0 +1,6 @@
+from importlib import metadata
+
+from .loader import Loader
+
+__all__ = ["Loader"]
+__version__ = metadata.version("plaster-yaml")

plaster_yaml-1.0.0/src/plaster_yaml/loader.py

@@ -0,0 +1,96 @@
+"""Implement a loader for plaster using yaml format."""
+import pathlib
+from logging.config import dictConfig
+from typing import Callable
+
+from importlib import metadata
+
+import plaster
+import yaml
+
+DEFAULT_LOGGING_CONFIG = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "console": {
+            "format": "%(asctime)s [%(levelname)s]: %(name)s - %(message)s",
+        },
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "level": "INFO",
+            "stream": "ext://sys.stderr",
+            "formatter": "console",
+        },
+    },
+    "root": {"level": "ERROR", "handlers": ["console"]},
+}
+
+
+def resolve_use(use: str, entrypoint: str) -> Callable:
+    try:
+        pkg, name = use.split("#")
+    except ValueError:
+        pkg, name = use, "main"
+    try:
+        scheme, pkg = pkg.split(":")
+    except ValueError:
+        scheme = "egg"
+    if scheme != "egg":
+        raise ValueError(f"{use}: unsupported scheme {scheme}")
+
+    eps = metadata.entry_points(group=entrypoint, name=name)
+    (runner,) = [ep for ep in eps if ep.module.split(".")[0] == pkg]
+    return runner.load()
+
+
+class Loader(plaster.ILoader):
+    def __init__(self, uri):
+        self.uri = uri
+
+        path = pathlib.Path(self.uri.path)
+        self.defaults = {
+            "__file__": str(path.absolute()),
+            "here": str(path.parent),
+        }
+        with open(self.uri.path, "r") as stream:
+            self._conf = yaml.safe_load(stream)
+
+    def get_sections(self):
+        return ["app"]
+
+    def get_settings(self, section=None, defaults=None):
+        # fallback to the fragment from config_uri if no section is given
+        if not section:
+            section = self.uri.fragment or "app"
+        # if section is still none we could fallback to some
+        # loader-specific default
+
+        result = self.defaults.copy()
+        if defaults is not None:
+            result.update(defaults)
+
+        settings = self._conf[section].copy()
+
+        for key, val in settings.items():
+            if isinstance(val, str):
+                if "%(here)s" in val:
+                    settings[key] = val % self.defaults
+        return settings
+
+    def get_wsgi_app_settings(self, name=None, defaults=None):
+        return self.get_settings(name, defaults)
+
+    def setup_logging(self, config_vars):
+        dictConfig(self._conf.get("logging", DEFAULT_LOGGING_CONFIG))
+
+    def get_wsgi_server(self, name=None, defaults=None):
+        settings = self.get_settings("server", defaults)
+        server = resolve_use(settings.pop("use"), "paste.server_runner")
+        return lambda app: server(app, self.defaults, **settings)
+
+    def get_wsgi_app(self, name=None, defaults=None):
+        settings = self.get_settings(name, defaults)
+        use = resolve_use(settings.pop("use"), "paste.app_factory")
+        return use(defaults, **settings)