risclog.logging 1.0__tar.gz

risclog.logging-1.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* riscLOG Solution GmbH <info@risclog.de>
+
+Contributors
+------------
+
+None yet. Why not be the first?

risclog.logging-1.0/CHANGES.rst

@@ -0,0 +1,9 @@
+==============================
+Change log for risclog.logging
+==============================
+
+
+1.0 (2024-08-06)
+================
+
+* initial release

risclog.logging-1.0/CONTRIBUTING.rst

@@ -0,0 +1,123 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/risclog-solution/risclog.logging/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+risclog.logging could always use more documentation, whether as part of the
+official risclog.logging docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/risclog-solution/risclog.logging/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `risclog.logging` for local development.
+
+1. Fork the `risclog.logging` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/risclog.logging.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv risclog.logging
+    $ cd risclog.logging/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests::
+
+    $ ./pytest
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.10 and 3.11. Check
+   https://travis-ci.com/risclog-solution/risclog.logging/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+    $ ./pytest -k test_main
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

risclog.logging-1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, riscLOG Solution GmbH
+
+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.

risclog.logging-1.0/MANIFEST.in

@@ -0,0 +1,32 @@
+include AUTHORS.rst
+include CHANGES.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+include src/risclog/logging/alembic/README
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-include src *.mako
+recursive-include src *.py
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+recursive-include src *.pdf
+exclude .env
+
+exclude requirements.lock
+exclude requirements.txt
+exclude appenv
+exclude pytest
+exclude pytest.ini
+exclude .editorconfig
+exclude .pre-commit-config.yaml
+exclude .isort.cfg
+exclude .env*
+exclude uvicorn
+exclude main
+exclude alembic
+exclude alembic.ini
+exclude Dockerfile

risclog.logging-1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.1
+Name: risclog.logging
+Version: 1.0
+Summary: A logger based on structlog
+Home-page: https://github.com/risclog-solution/risclog.logging
+Author: riscLOG Solution GmbH
+Author-email: info@risclog.de
+License: MIT license
+Keywords: risclog.logging
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: German
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.6
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: structlog
+Provides-Extra: docs
+Requires-Dist: Sphinx; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest-cache; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-flake8; extra == "test"
+Requires-Dist: pytest-rerunfailures; extra == "test"
+Requires-Dist: pytest-sugar; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: flake8<4; extra == "test"
+Requires-Dist: mock; extra == "test"
+Requires-Dist: requests; extra == "test"
+Requires-Dist: httpx; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+
+===============
+risclog.logging
+===============
+
+.. image:: https://github.com/risclog-solution/risclog.logging/workflows/Test/badge.svg?branch=master
+     :target: https://github.com/risclog-solution/risclog.logging/actions?workflow=Test
+     :alt: CI Status
+
+
+.. image:: https://img.shields.io/pypi/v/risclog.logging.svg
+        :target: https://pypi.python.org/pypi/risclog.logging
+
+.. image:: https://img.shields.io/travis/risclog-solution/risclog.logging.svg
+        :target: https://travis-ci.com/risclog-solution/risclog.logging
+
+.. image:: https://readthedocs.org/projects/risclog.logging/badge/?version=latest
+        :target: https://risclog.logging.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+The risclog.logging package provides a comprehensive solution for structured logging in Python applications. Risclog.logging uses structlog and logging to generate detailed and formatted log entries. The package supports both synchronous and asynchronous log messages and provides options for automatic e-mail notification of exception errors.
+
+
+* Free software: MIT license
+* Documentation: https://risclog.logging.readthedocs.io.
+
+
+Features
+========
+
+
+Creating a logger
+-----------------
+
+To create a logger, use the get_logger function. This function ensures that you get an instance of RiscLogger that is properly configured.
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    # create logger
+    logger = get_logger(name='my_logger')
+
+
+Configuration of the logger
+---------------------------
+
+The logger configuration takes place automatically when the logger instance is created using get_logger. The _configure_logger method sets up structlog and logging to provide logs with timestamps, context variables and formatting. You can customize the configuration as required.
+
+The module is configured to automatically read the logging level from an environment variable. By default, the level is set to `INFO`. To adjust this, set the `LOG_LEVEL` environment variable:
+
+.. code-block:: bash
+
+    export LOG_LEVEL=DEBUG
+
+
+Use the following methods to log messages with different log levels:
+
+* Debug-message: logger.debug("This is a debug message")
+* Info-message: logger.info("This is an info message")
+* Warning-message: logger.warning("This is a warning message")
+* Error-message: logger.error("This is an error message")
+* Critical-message: logger.critical("This is a critical message")
+* Fatal-message: logger.fatal("This is a fatal message")
+* Exception-message: logger.exception("This is an exception message")
+
+
+Asynchronous and synchronous log messages
+-----------------------------------------
+
+The risclog.logging package supports both synchronous and asynchronous log messages. If you are working in an asynchronous environment, use the asynchronous versions of the log methods:
+
+* Asynchronous debug message: await logger.debug("Async debug message")
+* Asynchronous info message: await logger.info("Async info message")
+* And so on...
+
+
+Decorator for logging
+---------------------
+
+The decorator decorator can be used to provide methods with automatic logging and optional e-mail notification of exceptions
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    logger = get_logger(name='my_logger')
+
+    @logger.decorator(send_email=True)
+    async def some_async_function(x, y):
+        return x + y
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    logger = get_logger(name='my_logger')
+
+    @logger.decorator
+    def some_sync_function(x, y):
+        return x + y
+
+
+Error handling and e-mail notification
+--------------------------------------
+
+If you set the send_email parameter to True, an email notification is automatically sent in the event of an exception. The email is sent asynchronously via a ThreadPoolExecutor and contains the exception details.
+
+**To be able to send e-mails, the following environment variables must be set!**
+
+* 'logging_email_smtp_user'
+* 'logging_email_smtp_password'
+* 'logging_email_to'
+* 'logging_email_smtp_server'
+
+
+Example
+-------
+
+Here is a complete example showing how to use the risclog.logginng package in an application
+
+
+.. code-block:: python
+
+    import os
+    import asyncio
+    from risclog.logging import get_logger
+
+
+    os.environ["LOG_LEVEL"] = "DEBUG"
+
+    logger = get_logger("async_debug_example")
+
+
+    @logger.decorator(send_email=True)
+    async def fetch_data(url: str):
+        await logger.debug(f"Start retrieving data from  {url}")
+        await asyncio.sleep(2)  # Simulates a delay, such as a network request
+        await logger.debug(f"Successfully retrieved data from {url}")
+        return {"data": f"Sample data from {url}"}
+
+
+    @logger.decorator
+    async def main():
+        url = "https://example.com"
+        await logger.debug(f"Start main function with URL: {url}")
+        data = await fetch_data(url)
+        await logger.debug(f"Data received: {data}")
+
+
+    if __name__ == "__main__":
+        logger.info("Start main function")
+        asyncio.run(main())
+
+
+output:
+
+.. code-block:: bash
+
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4378622064 __sender=inline message=Start main function
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4384943584 __sender=async_logging_decorator _function=main _script=example.py message=Method "main" called with no arguments.
+    2024-08-05 11:38:51 [debug    ] [async_debug_example] __id=4378552584 __sender=inline _function=main _script=example.py message=Start main function with URL: https://example.com
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4384943744 __sender=async_logging_decorator _function=fetch_data _script=example.py message=Method called: "fetch_data" with: "{'arg_0': 'https://example.com'}"
+    2024-08-05 11:38:51 [debug    ] [async_debug_example] __id=4366292144 __sender=inline _function=fetch_data _script=example.py message=Start retrieving data from  https://example.com
+    2024-08-05 11:38:53 [debug    ] [async_debug_example] __id=4366292144 __sender=inline _function=fetch_data _script=example.py message=Successfully retrieved data from https://example.com
+    2024-08-05 11:38:53 [info     ] [async_debug_example] __id=4384943744 __sender=async_logging_decorator _function=fetch_data _script=example.py message=Method "fetch_data" returned: "{'data': 'Sample data from https://example.com'}"
+    2024-08-05 11:38:53 [debug    ] [async_debug_example] __id=4378552584 __sender=inline message=Data received: {'data': 'Sample data from https://example.com'}
+    2024-08-05 11:38:53 [info     ] [async_debug_example] __id=4384943584 __sender=async_logging_decorator message=Method "main" returned: "None"
+
+
+
+Run tests::
+
+    $ ./pytest
+
+
+Credits
+=======
+
+This package was created with Cookiecutter_ and the `risclog-solution/risclog-cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`risclog-solution/risclog-cookiecutter-pypackage`: https://github.com/risclog-solution/risclog-cookiecutter-pypackage
+
+
+This package uses AppEnv_ for running tests inside this package.
+
+.. _AppEnv: https://github.com/flyingcircusio/appenv
+
+
+==============================
+Change log for risclog.logging
+==============================
+
+
+1.0 (2024-08-06)
+================
+
+* initial release

risclog.logging-1.0/README.rst

@@ -0,0 +1,187 @@
+===============
+risclog.logging
+===============
+
+.. image:: https://github.com/risclog-solution/risclog.logging/workflows/Test/badge.svg?branch=master
+     :target: https://github.com/risclog-solution/risclog.logging/actions?workflow=Test
+     :alt: CI Status
+
+
+.. image:: https://img.shields.io/pypi/v/risclog.logging.svg
+        :target: https://pypi.python.org/pypi/risclog.logging
+
+.. image:: https://img.shields.io/travis/risclog-solution/risclog.logging.svg
+        :target: https://travis-ci.com/risclog-solution/risclog.logging
+
+.. image:: https://readthedocs.org/projects/risclog.logging/badge/?version=latest
+        :target: https://risclog.logging.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+The risclog.logging package provides a comprehensive solution for structured logging in Python applications. Risclog.logging uses structlog and logging to generate detailed and formatted log entries. The package supports both synchronous and asynchronous log messages and provides options for automatic e-mail notification of exception errors.
+
+
+* Free software: MIT license
+* Documentation: https://risclog.logging.readthedocs.io.
+
+
+Features
+========
+
+
+Creating a logger
+-----------------
+
+To create a logger, use the get_logger function. This function ensures that you get an instance of RiscLogger that is properly configured.
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    # create logger
+    logger = get_logger(name='my_logger')
+
+
+Configuration of the logger
+---------------------------
+
+The logger configuration takes place automatically when the logger instance is created using get_logger. The _configure_logger method sets up structlog and logging to provide logs with timestamps, context variables and formatting. You can customize the configuration as required.
+
+The module is configured to automatically read the logging level from an environment variable. By default, the level is set to `INFO`. To adjust this, set the `LOG_LEVEL` environment variable:
+
+.. code-block:: bash
+
+    export LOG_LEVEL=DEBUG
+
+
+Use the following methods to log messages with different log levels:
+
+* Debug-message: logger.debug("This is a debug message")
+* Info-message: logger.info("This is an info message")
+* Warning-message: logger.warning("This is a warning message")
+* Error-message: logger.error("This is an error message")
+* Critical-message: logger.critical("This is a critical message")
+* Fatal-message: logger.fatal("This is a fatal message")
+* Exception-message: logger.exception("This is an exception message")
+
+
+Asynchronous and synchronous log messages
+-----------------------------------------
+
+The risclog.logging package supports both synchronous and asynchronous log messages. If you are working in an asynchronous environment, use the asynchronous versions of the log methods:
+
+* Asynchronous debug message: await logger.debug("Async debug message")
+* Asynchronous info message: await logger.info("Async info message")
+* And so on...
+
+
+Decorator for logging
+---------------------
+
+The decorator decorator can be used to provide methods with automatic logging and optional e-mail notification of exceptions
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    logger = get_logger(name='my_logger')
+
+    @logger.decorator(send_email=True)
+    async def some_async_function(x, y):
+        return x + y
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    logger = get_logger(name='my_logger')
+
+    @logger.decorator
+    def some_sync_function(x, y):
+        return x + y
+
+
+Error handling and e-mail notification
+--------------------------------------
+
+If you set the send_email parameter to True, an email notification is automatically sent in the event of an exception. The email is sent asynchronously via a ThreadPoolExecutor and contains the exception details.
+
+**To be able to send e-mails, the following environment variables must be set!**
+
+* 'logging_email_smtp_user'
+* 'logging_email_smtp_password'
+* 'logging_email_to'
+* 'logging_email_smtp_server'
+
+
+Example
+-------
+
+Here is a complete example showing how to use the risclog.logginng package in an application
+
+
+.. code-block:: python
+
+    import os
+    import asyncio
+    from risclog.logging import get_logger
+
+
+    os.environ["LOG_LEVEL"] = "DEBUG"
+
+    logger = get_logger("async_debug_example")
+
+
+    @logger.decorator(send_email=True)
+    async def fetch_data(url: str):
+        await logger.debug(f"Start retrieving data from  {url}")
+        await asyncio.sleep(2)  # Simulates a delay, such as a network request
+        await logger.debug(f"Successfully retrieved data from {url}")
+        return {"data": f"Sample data from {url}"}
+
+
+    @logger.decorator
+    async def main():
+        url = "https://example.com"
+        await logger.debug(f"Start main function with URL: {url}")
+        data = await fetch_data(url)
+        await logger.debug(f"Data received: {data}")
+
+
+    if __name__ == "__main__":
+        logger.info("Start main function")
+        asyncio.run(main())
+
+
+output:
+
+.. code-block:: bash
+
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4378622064 __sender=inline message=Start main function
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4384943584 __sender=async_logging_decorator _function=main _script=example.py message=Method "main" called with no arguments.
+    2024-08-05 11:38:51 [debug    ] [async_debug_example] __id=4378552584 __sender=inline _function=main _script=example.py message=Start main function with URL: https://example.com
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4384943744 __sender=async_logging_decorator _function=fetch_data _script=example.py message=Method called: "fetch_data" with: "{'arg_0': 'https://example.com'}"
+    2024-08-05 11:38:51 [debug    ] [async_debug_example] __id=4366292144 __sender=inline _function=fetch_data _script=example.py message=Start retrieving data from  https://example.com
+    2024-08-05 11:38:53 [debug    ] [async_debug_example] __id=4366292144 __sender=inline _function=fetch_data _script=example.py message=Successfully retrieved data from https://example.com
+    2024-08-05 11:38:53 [info     ] [async_debug_example] __id=4384943744 __sender=async_logging_decorator _function=fetch_data _script=example.py message=Method "fetch_data" returned: "{'data': 'Sample data from https://example.com'}"
+    2024-08-05 11:38:53 [debug    ] [async_debug_example] __id=4378552584 __sender=inline message=Data received: {'data': 'Sample data from https://example.com'}
+    2024-08-05 11:38:53 [info     ] [async_debug_example] __id=4384943584 __sender=async_logging_decorator message=Method "main" returned: "None"
+
+
+
+Run tests::
+
+    $ ./pytest
+
+
+Credits
+=======
+
+This package was created with Cookiecutter_ and the `risclog-solution/risclog-cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`risclog-solution/risclog-cookiecutter-pypackage`: https://github.com/risclog-solution/risclog-cookiecutter-pypackage
+
+
+This package uses AppEnv_ for running tests inside this package.
+
+.. _AppEnv: https://github.com/flyingcircusio/appenv

risclog.logging-1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = risclog.logging
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

risclog.logging-1.0/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst