lifecyclelogging 0.1.0__tar.gz

lifecyclelogging-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+
+1. Initialize logger with '...'
+2. Call method '....'
+3. See error
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Environment:**
+
+- Python version: [e.g. 3.8]
+- Package version: [e.g. 0.1.0]
+- OS: [e.g. Ubuntu 22.04]
+
+**Additional context**
+
+Add any other context about the problem here.

lifecyclelogging-0.1.0/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,23 @@
+---
+name: Documentation
+about: Report an issue or suggest an improvement for documentation
+title: '[DOCS] '
+labels: documentation
+assignees: ''
+---
+
+**Documentation Section**
+
+Which part of the documentation needs updating?
+
+**Current State**
+
+What does the current documentation say?
+
+**Suggested Changes**
+
+What changes would you like to see?
+
+**Additional Context**
+
+Add any other context about the documentation request here.

lifecyclelogging-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

lifecyclelogging-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,118 @@
+name: Continuous Delivery
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  initial_build_and_inspect:
+    name: Initial Build and Inspect
+    runs-on: ubuntu-latest
+    outputs:
+      artifact_name: ${{ steps.inspect.outputs.artifact-name }}
+      dist: ${{ steps.inspect.outputs.dist }}
+      supported_pythons: ${{ steps.inspect.outputs.supported_python_classifiers_json_array }}
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Build & Inspect Package
+        id: inspect
+        uses: hynek/build-and-inspect-python-package@v2
+
+  test:
+    name: Test Package with Tox
+    needs: initial_build_and_inspect
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ${{ fromJson(needs.initial_build_and_inspect.outputs.supported_pythons) }}
+
+    steps:
+      - name: Download Built Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.initial_build_and_inspect.outputs.artifact_name }}
+          path: dist
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install tox
+
+      - name: Run Tests with Tox
+        run: |
+          tar xf dist/*.tar.gz --strip-components=1
+          tox run -e py${{ matrix.python-version }}
+
+  release:
+    name: Semantic Release and Signed Build
+    needs: [initial_build_and_inspect, test]
+    runs-on: ubuntu-latest
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
+      attestations: write
+    outputs:
+      released: ${{ steps.release.outputs.released }}
+      version: ${{ steps.release.outputs.version }}
+      tag: ${{ steps.release.outputs.tag }}
+      signed_artifact_name: ${{ steps.signed_inspect.outputs.artifact-name }}
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Semantic Version Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v9.16.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+
+      - name: Signed Attestation Build & Inspect
+        if: steps.release.outputs.released == 'true'
+        id: signed_inspect
+        uses: hynek/build-and-inspect-python-package@v2
+        with:
+          attest-build-provenance-github: "true"
+          upload-name-suffix: "-signed"
+
+      - name: Publish to GitHub Releases
+        if: steps.release.outputs.released == 'true'
+        uses: python-semantic-release/publish-action@v9.16.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+
+  publish:
+    name: Publish to PyPI
+    needs: release
+    if: needs.release.outputs.released == 'true'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/lifecyclelogging/
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download Signed Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ needs.release.outputs.signed_artifact_name }}
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

lifecyclelogging-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,184 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: "1"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PIP_NO_PYTHON_VERSION_WARNING: "1"
+
+permissions: {}
+
+jobs:
+  build-package:
+    name: Build & verify package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: hynek/build-and-inspect-python-package@v2
+        id: baipp
+
+    outputs:
+      python-versions: ${{ steps.baipp.outputs.supported_python_classifiers_json_array }}
+
+  tests:
+    name: Tests on ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    needs: build-package
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ${{ fromJson(needs.build-package.outputs.python-versions) }}
+
+    env:
+      PYTHON: ${{ matrix.python-version }}
+
+    steps:
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+
+      - run: |
+          tar xf dist/*.tar.gz --strip-components=1
+          rm -rf src
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - name: Run tests
+        run: >
+          uvx --with tox-uv tox run
+          --installpkg dist/*.whl
+          -f py${PYTHON//./}-tests
+
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-data-${{ matrix.python-version }}
+          path: .coverage.*
+          include-hidden-files: true
+          if-no-files-found: ignore
+
+  coverage:
+    name: Ensure 100% test coverage
+    runs-on: ubuntu-latest
+    needs: tests
+    if: always()
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - name: Download coverage data
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-data-*
+          merge-multiple: true
+
+      - name: Combine coverage and fail if it's <100%.
+        run: |
+          uv tool install coverage
+
+          coverage combine
+          coverage html --skip-covered --skip-empty
+
+          # Report and write to summary.
+          coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+
+          # Report again and fail if under 100%.
+          coverage report --fail-under=100
+
+      - name: Upload HTML report if check failed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: htmlcov
+        if: ${{ failure() }}
+
+  typechecking:
+    name: Type Checking
+    runs-on: ubuntu-latest
+    needs: build-package
+
+    steps:
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+
+      - run: tar xf dist/*.tar.gz --strip-components=1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: >
+          uvx --with tox-uv
+          tox run -e type_check
+
+  docs:
+    name: Build and Verify Documentation
+    needs: build-package
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+
+      - run: tar xf dist/*.tar.gz --strip-components=1
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: >
+          uvx --with tox-uv
+          tox run -e docs
+
+  required-checks-pass:
+    name: Ensure everything required is passing for branch protection
+    if: always()
+
+    needs:
+      - coverage
+      - typechecking
+      - docs
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

lifecyclelogging-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual Environment
+venv/
+env/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.nox/
+.tox/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.pytest_cache/
+.hypothesis/
+
+# Logs
+*.log
+
+# Sphinx documentation
+docs/_build/
+docs/doctrees/
+docs/apidocs/
+*.doctree
+.aider*

lifecyclelogging-0.1.0/CHANGELOG.md

@@ -0,0 +1,69 @@
+# CHANGELOG
+
+
+## v0.1.0 (2025-01-25)
+
+### Bug Fixes
+
+- Ci
+  ([`d9fe7e7`](https://github.com/jbcom/lifecyclelogging/commit/d9fe7e798e9e52667332455276c3a08e24a95117))
+
+- Ci
+  ([`a01fd22`](https://github.com/jbcom/lifecyclelogging/commit/a01fd22296aeea52b95fb068a767be8fed591389))
+
+- Ci
+  ([`3896d9c`](https://github.com/jbcom/lifecyclelogging/commit/3896d9c49ceeed7d634e4ee615ff7fc9c1994771))
+
+- Ensure file handler is added for logging in lifecyclelogging module
+  ([`32904f6`](https://github.com/jbcom/lifecyclelogging/commit/32904f6ed09f49bc7d9ec96e5fd366db3a54a51e))
+
+- Orchestration
+  ([`88bc9a0`](https://github.com/jbcom/lifecyclelogging/commit/88bc9a0bfb0c9ec9877655c84da0fa2fdd8d05fa))
+
+- Renovate [skip actions]
+  ([`35a6d1c`](https://github.com/jbcom/lifecyclelogging/commit/35a6d1cfd47bbeda623cde3f0a543f46a3179b8d))
+
+- Resolve linting issues in logging utilities
+  ([`157b6e4`](https://github.com/jbcom/lifecyclelogging/commit/157b6e4c48085ea46f6c1e4f7804e3ea8b1c8ddb))
+
+- Resolve logging issues with verbosity bypass and file output handling
+  ([`2e1eee2`](https://github.com/jbcom/lifecyclelogging/commit/2e1eee2d4b51fdf459d5d12a7e3024134b8f26d0))
+
+- Resolve test failures by adjusting logging verbosity handling and file output
+  ([`8fa195a`](https://github.com/jbcom/lifecyclelogging/commit/8fa195a84f8b35ff3c05ff17c6041b68dab26688))
+
+- Resolve testing suite issues
+  ([`64ee345`](https://github.com/jbcom/lifecyclelogging/commit/64ee34589292238c89b321e32d2e37a4a07e1bc1))
+
+- Resolve verbosity bypass handling in logged_statement method
+  ([`80bb2e7`](https://github.com/jbcom/lifecyclelogging/commit/80bb2e7073475ed3a75d719f9cdbafd87c3f1376))
+
+### Chores
+
+- Add tox to gitignore [skip actions]
+  ([`5995d57`](https://github.com/jbcom/lifecyclelogging/commit/5995d57b7a6ca986d7f9a685910497ca596194f6))
+
+- Aider to gitignore
+  ([`d1e8cf0`](https://github.com/jbcom/lifecyclelogging/commit/d1e8cf01cbd5c1cf8a01e8706f8347850bfd9930))
+
+- Update renovate config [skip actions]
+  ([`5183f74`](https://github.com/jbcom/lifecyclelogging/commit/5183f74f4cdef7cce21374bb2bd52f9822da5299))
+
+- Updates to documentation
+  ([`90fe687`](https://github.com/jbcom/lifecyclelogging/commit/90fe6873147883c7740f013dba7df2d4f9250bbc))
+
+### Continuous Integration
+
+- Add uv support
+  ([`6c80570`](https://github.com/jbcom/lifecyclelogging/commit/6c80570f0f1e97208ae9b197739f513298c1f382))
+
+- Fixes
+  ([`3853fba`](https://github.com/jbcom/lifecyclelogging/commit/3853fba8deeef97f2a99a2574ec6213a69235115))
+
+- Split up workflows
+  ([`cffad5b`](https://github.com/jbcom/lifecyclelogging/commit/cffad5b650a3327118d8f3ba14ccca485000d896))
+
+### Features
+
+- First release version of LifecycleLogger
+  ([`93661ae`](https://github.com/jbcom/lifecyclelogging/commit/93661aec3229451d69e9fa75022e5f1c310523b3))

lifecyclelogging-0.1.0/LICENSE

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

lifecyclelogging-0.1.0/Makefile

@@ -0,0 +1,53 @@
+.PHONY: help clean test lint format check docs build env all
+.DEFAULT_GOAL := help
+
+help:  ## Display this help message
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} \
+	/^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2 } \
+	/^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) }' $(MAKEFILE_LIST)
+
+##@ Primary Commands
+all: clean check test docs build  ## Run all checks and tests
+
+##@ Development
+env:  ## Create the development environment (with all extras)
+	pip install -e '.[dev,test,docs]'
+	pip install tox tox-gh-actions
+
+clean: ## Clean up build artifacts and caches
+	tox -e clean
+
+##@ Testing
+test: ## Run tests
+	tox
+
+test-coverage: ## Run tests with coverage report
+	tox -e coverage_report
+
+##@ Code Quality
+lint: ## Run linting
+	tox -e lint
+
+format: ## Format code and sort imports
+	tox -e format
+
+type: ## Run type checking
+	tox -e type_check
+
+check: lint type ## Run all code quality checks
+
+##@ Documentation
+docs: ## Build documentation
+	mkdir -p docs/_build
+	tox -e docs
+
+docs-serve: ## Serve documentation locally
+	python -m http.server --directory docs/_build/html
+
+docs-clean: ## Clean documentation build
+	tox -e clean
+
+##@ Building
+build: clean ## Build the package
+	pip install build
+	python -m build