tinystructlog 0.1.2__tar.gz

tinystructlog-0.1.2/.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.{md,rst}]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

tinystructlog-0.1.2/.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Build documentation
+        run: |
+          cd docs
+          sphinx-build -W -b html . _build/html
+
+      - name: Upload documentation artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/_build/html

tinystructlog-0.1.2/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/*
+          generate_release_notes: true
+          body: |
+            See [CHANGELOG.md](https://github.com/Aprova-GmbH/tinystructlog/blob/main/CHANGELOG.md) for details.

tinystructlog-0.1.2/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run linters
+        run: |
+          black --check src tests
+          ruff check src tests
+
+      - name: Run tests with coverage
+        run: |
+          pytest --cov=contexlog --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.12'
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}

tinystructlog-0.1.2/.gitignore

@@ -0,0 +1,78 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.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
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Sphinx documentation
+docs/_build/
+docs/_static/
+docs/_templates/
+
+# MyPy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Ruff
+.ruff_cache/
+
+# Build artifacts
+*.whl
+*.tar.gz

tinystructlog-0.1.2/.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev

tinystructlog-0.1.2/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.2] - 2026-01-18
+
+### Added
+- Documentation update: added comparison with loguru
+
+## [0.1.1] - 2026-01-18
+
+### Added
+- Custom log format support via `fmt` and `datefmt` parameters in `get_logger()`
+- Preset format constants: `MINIMAL_FORMAT`, `DETAILED_FORMAT`, `SIMPLE_FORMAT`
+- Exported `DEFAULT_FORMAT` and `DEFAULT_DATEFMT` constants for reference
+- Comprehensive examples for custom formats in README and documentation
+
+### Changed
+- Documentation now explicitly states that v0.1.0 had an opinionated, hardcoded format
+- Enhanced API documentation with custom format examples and usage patterns
+
+### Note
+- **Fully backward compatible** - default behavior unchanged from v0.1.0
+- Calling `get_logger(__name__)` without parameters produces identical output to v0.1.0
+
+## [0.1.0] - 2024-01-17
+
+### Added
+- Initial release of contexlog
+- Core context management with `set_log_context()`, `clear_log_context()`, and `log_context()`
+- Context-aware logger creation with `get_logger()`
+- Thread-safe and async-safe context isolation using `contextvars`
+- Colored terminal output with `ColoredFormatter`
+- Context injection via `ContextFilter`
+- Zero runtime dependencies
+- Full type hints support (PEP 561)
+- Comprehensive test suite with >90% coverage
+- Documentation and examples
+- MIT license
+
+
+[0.1.2]: https://github.com/vykhand/tinystructlog/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/vykhand/tinystructlog/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/vykhand/tinystructlog/releases/tag/v0.1.0

tinystructlog-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# Contributing to contexlog
+
+Thank you for your interest in contributing to contexlog! This document provides guidelines and instructions for contributing.
+
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create an issue on GitHub with:
+- A clear, descriptive title
+- Steps to reproduce the issue
+- Expected vs. actual behavior
+- Python version and OS
+- Code samples or test cases if possible
+
+### Suggesting Enhancements
+
+Enhancement suggestions are welcome! Please create an issue with:
+- A clear description of the enhancement
+- Use cases and examples
+- Potential implementation approach (optional)
+
+### Pull Requests
+
+1. **Fork the repository** and create a new branch from `main`
+2. **Set up the development environment**:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/contexlog.git
+   cd contexlog
+   python -m venv .venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   pip install -e ".[dev]"
+   ```
+
+3. **Make your changes**:
+   - Write clear, readable code
+   - Add tests for new functionality
+   - Update documentation as needed
+   - Follow the existing code style
+
+4. **Run tests and checks**:
+   ```bash
+   # Run tests with coverage
+   pytest
+
+   # Format code with Black
+   black src tests examples
+
+   # Lint with Ruff
+   ruff check src tests examples
+
+   # Type check (optional)
+   mypy src
+   ```
+
+5. **Ensure all tests pass** and coverage remains >90%
+
+6. **Commit your changes**:
+   - Use clear, descriptive commit messages
+   - Reference related issues (e.g., "Fix #123: ...")
+
+7. **Push to your fork** and submit a pull request
+
+8. **Respond to review feedback** - we'll review your PR and may suggest changes
+
+## Development Guidelines
+
+### Code Style
+
+- **Python version**: 3.11+
+- **Line length**: 100 characters (Black default)
+- **Formatting**: Use Black for code formatting
+- **Linting**: Code must pass Ruff checks
+- **Type hints**: Add type hints to all public APIs
+
+### Testing
+
+- Write tests for all new functionality
+- Maintain test coverage >90%
+- Use pytest for testing
+- Test both sync and async code paths
+- Test error conditions and edge cases
+
+### Documentation
+
+- Update README.md for user-facing changes
+- Add docstrings (Google style) to all public functions and classes
+- Update API documentation in `docs/` if needed
+- Add examples for new features
+
+### Commit Messages
+
+Use clear, descriptive commit messages:
+
+```
+Add support for custom formatters
+
+- Implement CustomFormatter class
+- Add tests for custom formatter
+- Update documentation with examples
+
+Fixes #123
+```
+
+## Project Structure
+
+```
+contexlog/
+├── src/contexlog/      # Source code
+│   ├── __init__.py     # Package exports
+│   ├── core.py         # Main implementation
+│   └── py.typed        # Type hint marker
+├── tests/              # Test suite
+├── docs/               # Documentation
+├── examples/           # Usage examples
+└── .github/workflows/  # CI/CD workflows
+```
+
+## Release Process
+
+(For maintainers)
+
+1. Update version in `pyproject.toml` and `src/contexlog/__init__.py`
+2. Update `CHANGELOG.md`
+3. Create a git tag: `git tag v0.x.0`
+4. Push tag: `git push origin v0.x.0`
+5. GitHub Actions will automatically build and publish to PyPI
+
+## Questions?
+
+Feel free to open an issue for questions or join discussions in GitHub Discussions (if enabled).
+
+## License
+
+By contributing to contexlog, you agree that your contributions will be licensed under the Apache License 2.0.

tinystructlog-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aprova 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.

tinystructlog-0.1.2/MANIFEST.in

@@ -0,0 +1,26 @@
+# Include documentation and license files
+include LICENSE
+include README.md
+include CHANGELOG.md
+include CONTRIBUTING.md
+include CODE_OF_CONDUCT.md
+include SECURITY.md
+
+# Include package marker for type hints
+include src/contexlog/py.typed
+
+# Include tests
+recursive-include tests *.py
+
+# Include examples
+recursive-include examples *.py
+
+# Exclude build artifacts and CI files
+exclude .gitignore
+exclude .editorconfig
+exclude .readthedocs.yaml
+recursive-exclude .github *
+recursive-exclude docs *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store