loggio 2025.12.13__tar.gz

loggio-2025.12.13/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

loggio-2025.12.13/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

loggio-2025.12.13/PKG-INFO

@@ -0,0 +1,286 @@
+Metadata-Version: 2.4
+Name: loggio
+Version: 2025.12.13
+Summary: Comprehensive logging utility with colored output, user context tracking, and automatic truncation.
+Project-URL: Homepage, https://github.com/xcollantes/loggio
+Project-URL: Repository, https://github.com/xcollantes/loggio
+Project-URL: Issues, https://github.com/xcollantes/loggio/issues
+Author-email: Xavier Collantes <collantes.xavier@gmail.com>
+Maintainer-email: Xavier Collantes <collantes.xavier@gmail.com>
+License-Expression: CC0-1.0
+License-File: LICENSE
+Keywords: automatic truncation,colored,debugging,enhanced,logger,logging,terminal,user context
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Enhanced Logger Loggio
+
+A comprehensive logging utility for project that provides:
+
+- Timestamp information in logs
+- User ID tracking for authenticated requests
+- File name and line number of the log call
+- Clean and consistent log formatting
+- Multiple usage patterns for different scenarios
+
+## Features
+
+- **Contextual Information**: Every log includes timestamp, log level, file
+  name, and line number
+- **Authentication Awareness**: Can include user ID in logs when available
+- **Format String Support**: Supports Python's standard string formatting with
+  %s, %d, etc.
+- **Flexible Configuration**: Configurable output destination (terminal and/or
+  file)
+- **Consistent API**: Familiar logging methods (debug, info, warning, error,
+  critical)
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install loggio
+```
+
+Then import in your code:
+
+```python
+from loggio import get_logger
+```
+
+### From Source
+
+To use standalone, use as a fork.
+
+To get updates, use as a submodule.
+
+#### As standalone
+
+Go to inside your project.
+
+Clone the repository:
+
+```bash
+git clone https://github.com/xcollantes/loggio loggio
+```
+
+#### As submodule to existing repo
+
+Go to where you want to dependency.
+
+Clone the repository as submodule:
+
+`loggio` must be maintained since Python import statements don't work
+work hyphens.
+
+```bash
+git submodule add https://github.com/xcollantes/loggio loggio
+```
+
+#### Cloning your project that contains submodules
+
+Clone the repository with submodules:
+
+```bash
+git clone --recursive https://github.com/xcollantes/my-project-with-submodules
+```
+
+Remember `--recursive` for submodules.
+
+If you clone without --recursive:
+
+```bash
+git submodule update --init --recursive
+```
+
+#### Create and Activate Virtual Environment
+
+```bash
+# Create virtual environment.
+python3 -m venv env
+
+# Activate virtual environment.
+# On macOS/Linux:
+source env/bin/activate
+
+# On Windows:
+# venv\Scripts\activate
+```
+
+#### Install Dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+#### Environment Configuration
+
+Create a `.env` file in the project root with the required environment
+variables. The following variables are used by the application:
+
+#### Running the Application
+
+#### Basic Usage
+
+```bash
+python3 main.py
+```
+
+## Usage Examples
+
+### Basic Usage (No Authentication)
+
+For utility functions, background tasks, or non-authenticated endpoints:
+
+```python
+from loggio import get_logger
+
+# Create a logger instance.
+logger = get_logger(name="module.name")
+
+# Log messages with different levels
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.warning("This is a warning message.")
+```
+
+Output example:
+
+```
+INFO:2023-05-01 14:30:45:example.py:24:This is an info message.
+```
+
+### Using Format Strings
+
+The logger supports Python's standard string formatting:
+
+```python
+from loggio import get_logger
+
+logger = get_logger(name="module.formatter")
+
+# Using format strings
+item_id = "A123"
+priority = 2
+logger.info("Processing item %s with priority %d", item_id, priority)
+```
+
+Output example:
+
+```
+INFO:2023-05-01 14:31:22:formatter.py:15:Processing item A123 with priority 2
+```
+
+### Usage with User Context
+
+When you have authentication info:
+
+```python
+from loggio import get_logger
+
+# Create a logger instance.
+logger = get_logger(name="module.auth")
+
+# Get user info from somewhere (e.g., decoded token)
+user_info = {"uid": "user123", "email": "user@example.com"}
+
+# Log with user context
+logger.info("User performed an action.", user_context=user_info)
+```
+
+Output example:
+
+```
+INFO:2023-05-01 14:32:10:auth_service.py:45:user123: User performed an action.
+```
+
+### Format Strings with User Context
+
+Combining format strings with user context:
+
+```python
+logger.info("Processing file %s for action %s", filename, action, user_context=user_info)
+```
+
+### Error Handling with Logging
+
+```python
+try:
+    # Some risky operation
+    result = perform_risky_operation()
+    logger.info(f"Operation successful: {result}")
+except Exception as e:
+    logger.error(f"Operation failed: {str(e)}")
+    # Handle or re-raise as appropriate
+```
+
+## Configuration Options
+
+When creating a logger instance, you can configure:
+
+- `name`: Logger name for filtering and organization (e.g., "api.auth",
+  "service.processor")
+- `level`: Minimum log level (DEBUG, INFO, WARNING, ERROR, CRITICAL) - defaults
+  to "INFO"
+- `fileout`: Whether to write logs to a file (default: False)
+- `terminal`: Whether to output logs to the terminal/console (default: True)
+- `fileout_path`: Path for log file if `fileout` is True (default:
+  "logs/app.log")
+
+Example with custom configuration:
+
+```python
+logger = get_logger(
+    name="batch.processor",
+    level="DEBUG",
+    fileout=True,
+    fileout_path="logs/batch_processor.log",
+    terminal=True
+)
+```
+
+## Log Format
+
+The logger produces logs in the following format:
+
+```
+LEVEL:TIMESTAMP:FILENAME:LINE_NUMBER:MESSAGE
+```
+
+For example:
+
+```
+INFO:2023-05-01 14:35:22:auth_routes.py:28:user123: Processing protected resource request
+```
+
+## Best Practices
+
+1. Use a hierarchical naming scheme for loggers (e.g., `api.auth`,
+   `service.processor`)
+2. Include meaningful context in log messages
+3. Use the appropriate log level for different scenarios:
+   - DEBUG: Detailed information for debugging
+   - INFO: Confirmation that things are working as expected
+   - WARNING: Something unexpected happened, but the application can continue
+   - ERROR: A more serious problem that prevented a function from working
+   - CRITICAL: A very serious error that might prevent the program from
+     continuing
+4. Include user context when available for better traceability
+5. Include error details when logging exceptions
+
+## Implementation Details
+
+The Enhanced Logger builds on Python's built-in logging module with custom
+formatting and context handling. It uses `stacklevel=2` to ensure the correct
+file and line number are recorded in the logs rather than showing the logger
+implementation file itself.