plaster_yaml 0.1.1__tar.gz

plaster_yaml-0.1.1/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Version 0.1.1 - 2021-04-26
+
+* Fix default logging
+
+## Version 0.1.0 - 2021-04-26
+
+* Initial Release

plaster_yaml-0.1.1/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-0.1.1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.1
+Name: plaster-yaml
+Version: 0.1.1
+Summary: A plaster plugin to configure pyramid app with Yaml
+License: BSD-derived (http://www.repoze.org/LICENSE.txt)
+Author: Guillaume Gauvrit
+Author-email: guillaume@gauvr.it
+Requires-Python: >=3.7,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
+Requires-Dist: plaster (>=1.0,<2.0)
+Description-Content-Type: text/markdown
+
+# Plaster Yaml
+
+## Introduction
+
+By default, Pyramid use a paste format file to loads its configuration,
+
+here is a plugin to use a yaml file instead to configure your pyramid
+application.
+
+e.g.
+
+```
+pserve development.yaml
+```
+
+## Installation
+
+## With poetry
+
+```
+poetry add plaster-yaml
+```
+
+## With pip
+
+```
+pip install plaster-yaml
+```
+
+## Usage
+
+## With poetry
+
+You need to register this plugin in your `pyproject.toml`:
+
+
+```
+[tool.poetry.plugins."paste.app_factory"]
+main = "<PATH_TO_MODULE_CONTAINING_MAIN>:main"
+
+[tool.poetry.plugins."plaster.loader_factory"]
+"file+yaml" = "plaster_yaml:Loader"
+```
+
+You must run `poetry install` to finalize the registration.
+
+## With setuptools
+
+```
+setup(
+    ...,
+    entry_points={
+     'paste.app_factory': ['main = <my_app>:main'],
+     'plaster.loader_factory': ['yaml = plaster_yaml:Loader'],
+     ...
+    },
+)
+```
+
+You must run `pip install -e .` to finallize the registration.
+
+## Troubleshouting
+
+If you get the following exception:
+
+```
+plaster.exceptions.LoaderNotFound: Could not find a matching loader for the scheme "file+yaml", protocol "wsgi".
+```
+
+It meast that you did not register the pluging. Read the usage section
+for to register it properly.
+
+

plaster_yaml-0.1.1/README.md

@@ -0,0 +1,72 @@
+# Plaster Yaml
+
+## Introduction
+
+By default, Pyramid use a paste format file to loads its configuration,
+
+here is a plugin to use a yaml file instead to configure your pyramid
+application.
+
+e.g.
+
+```
+pserve development.yaml
+```
+
+## Installation
+
+## With poetry
+
+```
+poetry add plaster-yaml
+```
+
+## With pip
+
+```
+pip install plaster-yaml
+```
+
+## Usage
+
+## With poetry
+
+You need to register this plugin in your `pyproject.toml`:
+
+
+```
+[tool.poetry.plugins."paste.app_factory"]
+main = "<PATH_TO_MODULE_CONTAINING_MAIN>:main"
+
+[tool.poetry.plugins."plaster.loader_factory"]
+"file+yaml" = "plaster_yaml:Loader"
+```
+
+You must run `poetry install` to finalize the registration.
+
+## With setuptools
+
+```
+setup(
+    ...,
+    entry_points={
+     'paste.app_factory': ['main = <my_app>:main'],
+     'plaster.loader_factory': ['yaml = plaster_yaml:Loader'],
+     ...
+    },
+)
+```
+
+You must run `pip install -e .` to finallize the registration.
+
+## Troubleshouting
+
+If you get the following exception:
+
+```
+plaster.exceptions.LoaderNotFound: Could not find a matching loader for the scheme "file+yaml", protocol "wsgi".
+```
+
+It meast that you did not register the pluging. Read the usage section
+for to register it properly.
+

plaster_yaml-0.1.1/pyproject.toml

@@ -0,0 +1,27 @@
+[tool.poetry]
+name = "plaster_yaml"
+version = "0.1.1"
+description = "A plaster plugin to configure pyramid app with Yaml"
+readme = "README.md"
+authors = ["Guillaume Gauvrit <guillaume@gauvr.it>"]
+include = ["CHANGELOG.md"]
+license = "BSD-derived (http://www.repoze.org/LICENSE.txt)"
+
+[tool.poetry.dependencies]
+python = "^3.7"
+plaster = "^1.0"
+PyYAML = "^5.4.1"
+
+[tool.poetry.dev-dependencies]
+black = "^21.4b0"
+isort = "^5.8.0"
+# Tests
+gunicorn = "^20.1.0"
+PasteDeploy = "^2.1.1"
+pytest = "^5.2"
+waitress = "^2.0.0"
+pyramid-helloworld = "^0.1.2"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

plaster_yaml-0.1.1/setup.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+package_dir = \
+{'': 'src'}
+
+packages = \
+['plaster_yaml']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['PyYAML>=5.4.1,<6.0.0', 'plaster>=1.0,<2.0']
+
+setup_kwargs = {
+    'name': 'plaster-yaml',
+    'version': '0.1.1',
+    'description': 'A plaster plugin to configure pyramid app with Yaml',
+    'long_description': '# Plaster Yaml\n\n## Introduction\n\nBy default, Pyramid use a paste format file to loads its configuration,\n\nhere is a plugin to use a yaml file instead to configure your pyramid\napplication.\n\ne.g.\n\n```\npserve development.yaml\n```\n\n## Installation\n\n## With poetry\n\n```\npoetry add plaster-yaml\n```\n\n## With pip\n\n```\npip install plaster-yaml\n```\n\n## Usage\n\n## With poetry\n\nYou need to register this plugin in your `pyproject.toml`:\n\n\n```\n[tool.poetry.plugins."paste.app_factory"]\nmain = "<PATH_TO_MODULE_CONTAINING_MAIN>:main"\n\n[tool.poetry.plugins."plaster.loader_factory"]\n"file+yaml" = "plaster_yaml:Loader"\n```\n\nYou must run `poetry install` to finalize the registration.\n\n## With setuptools\n\n```\nsetup(\n    ...,\n    entry_points={\n     \'paste.app_factory\': [\'main = <my_app>:main\'],\n     \'plaster.loader_factory\': [\'yaml = plaster_yaml:Loader\'],\n     ...\n    },\n)\n```\n\nYou must run `pip install -e .` to finallize the registration.\n\n## Troubleshouting\n\nIf you get the following exception:\n\n```\nplaster.exceptions.LoaderNotFound: Could not find a matching loader for the scheme "file+yaml", protocol "wsgi".\n```\n\nIt meast that you did not register the pluging. Read the usage section\nfor to register it properly.\n\n',
+    'author': 'Guillaume Gauvrit',
+    'author_email': 'guillaume@gauvr.it',
+    'maintainer': None,
+    'maintainer_email': None,
+    'url': None,
+    'package_dir': package_dir,
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'python_requires': '>=3.7,<4.0',
+}
+
+
+setup(**setup_kwargs)

plaster_yaml-0.1.1/src/plaster_yaml/__init__.py

@@ -0,0 +1,5 @@
+import pkg_resources
+
+from .loader import Loader  # noqa
+
+__version__ = pkg_resources.get_distribution("plaster-yaml").version

plaster_yaml-0.1.1/src/plaster_yaml/loader.py

@@ -0,0 +1,92 @@
+"""Implement a loader for plaster using yaml format."""
+import pathlib
+from logging.config import dictConfig
+from typing import Callable
+
+import pkg_resources
+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}")
+
+    distribution = pkg_resources.get_distribution(pkg)
+    runner = distribution.get_entry_info(entrypoint, name)
+    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 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)