structlog-config 0.1.0__tar.gz

structlog_config-0.1.0/.copier-answers.yml

@@ -0,0 +1,2 @@
+# this exact file name is required in this exact location if updates are to work
+{"_commit": "v0.2.1-31-gb45b358", "_src_path": "https://github.com/iloveitaly/python-package-template", "project_name": "structlog_config", "full_name": "Michael Bianco", "email": "mike@mikebian.co", "github_username": "iloveitaly"}

structlog_config-0.1.0/.envrc

@@ -0,0 +1,11 @@
+layout uv
+
+export LOG_LEVEL=DEBUG
+
+# make sure none of the logging is unbuffered
+export PYTHONUNBUFFERED=1
+
+# required in order to avoid color codes in logging output for tests
+export NO_COLOR=1
+
+export PYTHONBREAKPOINT=pdbr.set_trace

structlog_config-0.1.0/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

structlog_config-0.1.0/.github/workflows/build_and_publish.yml

@@ -0,0 +1,56 @@
+name: Build and Publish to PyPI
+on:
+  push:
+    branches:
+      - main
+      - master
+
+permissions:
+  contents: write
+
+env:
+  PIP_DEFAULT_TIMEOUT: 60
+  PIP_RETRIES: 5
+
+  # required otherwise github api calls are rate limited
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  matrix-test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.13", "3.12", "3.11"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+      - run: mise use python@${{ matrix.python-version }}
+      - uses: iloveitaly/github-action-direnv-load-and-mask@master
+      - run: uv sync
+      - run: uv run pytest
+
+  release-please:
+    needs: matrix-test
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          release-type: python
+          token: ${{ secrets.GH_PERSONAL_TOKEN }}
+
+  build-and-publish:
+    needs: release-please
+    runs-on: ubuntu-latest
+    if: ${{ needs.release-please.outputs.release_created }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jdx/mise-action@v2
+      - uses: iloveitaly/github-action-direnv-load-and-mask@master
+      - run: uv sync
+      - run: uv build
+      - run: uv publish --token ${{ secrets.PYPI_API_TOKEN }}

structlog_config-0.1.0/.github/workflows/repo-sync.yml

@@ -0,0 +1,16 @@
+name: Repository Metadata Sync
+
+on:
+  push:
+    branches: [main, master]
+
+jobs:
+  repo_sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetching Local Repository
+        uses: actions/checkout@v4
+      - name: Repository Metadata Sync
+        uses: iloveitaly/github-actions-metadata-sync@main
+        with:
+          TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}

structlog_config-0.1.0/.gitignore

@@ -0,0 +1,129 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/

structlog_config-0.1.0/.tool-versions

@@ -0,0 +1,3 @@
+python 3.13.2
+uv 0.6.6
+direnv 2.35.0

structlog_config-0.1.0/.vscode/settings.json

@@ -0,0 +1,36 @@
+{
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    },
+    "editor.tabSize": 4
+  },
+  "[toml]": {
+    "editor.formatOnSave": true,
+    "editor.tabSize": 4
+  },
+  "python.analysis.autoFormatStrings": true,
+
+  // for import autosuggest
+  "python.analysis.indexing": true,
+  "python.analysis.autoImportCompletions": true,
+
+  "python.analysis.packageIndexDepths": [
+    {
+      "name": "",
+      "depth": 3,
+      "includeAllSymbols": true
+    }
+  ],
+
+  "cSpell.words": ["openai", "httpx"],
+
+  "files.exclude": {
+    ".ruff_cache": true,
+    ".pytest_cache": true,
+    ".venv": true
+  }
+}

structlog_config-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.1.0 (2025-04-14)
+
+
+### Features
+
+* add PathPrettifier for structlog path formatting ([b54bc58](https://github.com/iloveitaly/structlog-config/commit/b54bc58ef5d896675a69d809704829b3976763b7))
+* add RenameField processor for log key renaming ([a07bf36](https://github.com/iloveitaly/structlog-config/commit/a07bf363aa97631978c141c7385932f76ac30398))
+* add structured access logging for FastAPI requests ([37d506d](https://github.com/iloveitaly/structlog-config/commit/37d506dec89fc9c0de6a548371724c2342c0bafc))
+* allow loggers to be configured from environment variables ([417acf1](https://github.com/iloveitaly/structlog-config/commit/417acf1b9f5c0219191486c26ccdf6959956f329))
+* configure loggers via env variables in env_config.py ([2b920c4](https://github.com/iloveitaly/structlog-config/commit/2b920c4b0c373aabcb6b7d31503205268308ed83))
+* debug log static asset requests in FastAPI logger ([d8e5ee0](https://github.com/iloveitaly/structlog-config/commit/d8e5ee01af6b4ad5027010bf459fddf55263c8fc))
+* determine which optional packages are installed ([7e062e2](https://github.com/iloveitaly/structlog-config/commit/7e062e2a50902ce53295730d8ad69faa387b1997))
+* improve CI workflow and project setup ([2338dd0](https://github.com/iloveitaly/structlog-config/commit/2338dd06ed1c044123a11f5cc08278130da31d21))
+* update logger config for testing and add is_pytest function ([fe579ca](https://github.com/iloveitaly/structlog-config/commit/fe579ca8c0210934ca7d85294b6d3b5a1d567c68))
+
+
+### Bug Fixes
+
+* dynamically pull the LOG_LEVEL from env for testing ([0cceb7c](https://github.com/iloveitaly/structlog-config/commit/0cceb7c541bd3f2d03ccf71392ee56ba5ae7f0bd))
+* ensure copier uses current HEAD for updates ([20b9f9d](https://github.com/iloveitaly/structlog-config/commit/20b9f9d64f7c09d22d149162af332954cad5d070))
+
+
+### Documentation
+
+* add comments to middleware and formatter functions ([bf43006](https://github.com/iloveitaly/structlog-config/commit/bf43006ad538aa9e369c9a9fa251161feee0ea77))
+* add FastAPI access logger section to README.md ([93c6d98](https://github.com/iloveitaly/structlog-config/commit/93c6d98e5441f6f4c5e69dc9c618dfcfb556e7f4))
+* elaborate on FastAPI Access Logger usage and benefits ([aa4223e](https://github.com/iloveitaly/structlog-config/commit/aa4223e9db3726d5c12e699116ab84063103765b))
+* update project description and keywords in pyproject.toml ([6424d8a](https://github.com/iloveitaly/structlog-config/commit/6424d8a440d474a8feb4c8ddff322b2e17241126))

structlog_config-0.1.0/Makefile

@@ -0,0 +1,11 @@
+setup:
+	uv venv && uv sync
+	@echo "activate: source ./.venv/bin/activate"
+
+clean:
+	rm -rf *.egg-info
+	rm -rf .venv
+
+update_copier:
+	uv tool run --with jinja2_shell_extension \
+		copier@latest update --vcs-ref=HEAD --trust --skip-tasks --skip-answered

structlog_config-0.1.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: structlog-config
+Version: 0.1.0
+Summary: A comprehensive structlog configuration with sensible defaults for development and production environments, featuring context management, exception formatting, and path prettification.
+Project-URL: Repository, https://github.com/iloveitaly/structlog-config
+Author-email: Michael Bianco <mike@mikebian.co>
+Keywords: json-logging,logging,structlog,structured-logging
+Requires-Python: >=3.10
+Requires-Dist: orjson>=3.10.15
+Requires-Dist: python-decouple-typed>=3.11.0
+Requires-Dist: structlog>=25.2.0
+Description-Content-Type: text/markdown
+
+# Structlog Configuration
+
+Logging is really important:
+
+* High performance JSON logging in production
+* All loggers, even plugin or system loggers, should route through the same formatter
+* Structured logging everywhere
+* Ability to easily set thread-local log context
+
+## Stdib Log Management
+
+Note that `{LOGGER_NAME}` is the name of the system logger assigned via `logging.getLogger(__name__)`:
+
+* `OPENAI_LOG_LEVEL`
+* `OPENAI_LOG_PATH`. Ignored in production.
+
+## FastAPI Access Logger
+
+Structured, simple access log with request timing to replace the default fastapi access log. Why?
+
+1. It's less verbose
+2. Uses structured logging params instead of string interpolation
+3. debug level logs any static assets
+
+Here's how to use it:
+
+1. [Disable fastapi's default logging.](https://github.com/iloveitaly/python-starter-template/blob/f54cb47d8d104987f2e4a668f9045a62e0d6818a/main.py#L55-L56)
+2. [Add the middleware to your FastAPI app.](https://github.com/iloveitaly/python-starter-template/blob/f54cb47d8d104987f2e4a668f9045a62e0d6818a/app/routes/middleware/__init__.py#L63-L65)
+
+Adapted from:
+
+- https://github.com/iloveitaly/fastapi-logger/blob/main/fastapi_structlog/middleware/access_log.py#L70
+- https://github.com/fastapiutils/fastapi-utils/blob/master/fastapi_utils/timing.py
+- https://pypi.org/project/fastapi-structlog/
+- https://pypi.org/project/asgi-correlation-id/
+- https://gist.github.com/nymous/f138c7f06062b7c43c060bf03759c29e
+- https://github.com/sharu1204/fastapi-structlog/blob/master/app/main.py
+
+## Related Projects
+
+* https://github.com/underyx/structlog-pretty
+* https://pypi.org/project/httpx-structlog/
+
+## References
+
+- https://github.com/replicate/cog/blob/2e57549e18e044982bd100e286a1929f50880383/python/cog/logging.py#L20
+- https://github.com/apache/airflow/blob/4280b83977cd5a53c2b24143f3c9a6a63e298acc/task_sdk/src/airflow/sdk/log.py#L187
+- https://github.com/kiwicom/structlog-sentry
+- https://github.com/jeremyh/datacube-explorer/blob/b289b0cde0973a38a9d50233fe0fff00e8eb2c8e/cubedash/logs.py#L40C21-L40C42

structlog_config-0.1.0/README.md

@@ -0,0 +1,49 @@
+# Structlog Configuration
+
+Logging is really important:
+
+* High performance JSON logging in production
+* All loggers, even plugin or system loggers, should route through the same formatter
+* Structured logging everywhere
+* Ability to easily set thread-local log context
+
+## Stdib Log Management
+
+Note that `{LOGGER_NAME}` is the name of the system logger assigned via `logging.getLogger(__name__)`:
+
+* `OPENAI_LOG_LEVEL`
+* `OPENAI_LOG_PATH`. Ignored in production.
+
+## FastAPI Access Logger
+
+Structured, simple access log with request timing to replace the default fastapi access log. Why?
+
+1. It's less verbose
+2. Uses structured logging params instead of string interpolation
+3. debug level logs any static assets
+
+Here's how to use it:
+
+1. [Disable fastapi's default logging.](https://github.com/iloveitaly/python-starter-template/blob/f54cb47d8d104987f2e4a668f9045a62e0d6818a/main.py#L55-L56)
+2. [Add the middleware to your FastAPI app.](https://github.com/iloveitaly/python-starter-template/blob/f54cb47d8d104987f2e4a668f9045a62e0d6818a/app/routes/middleware/__init__.py#L63-L65)
+
+Adapted from:
+
+- https://github.com/iloveitaly/fastapi-logger/blob/main/fastapi_structlog/middleware/access_log.py#L70
+- https://github.com/fastapiutils/fastapi-utils/blob/master/fastapi_utils/timing.py
+- https://pypi.org/project/fastapi-structlog/
+- https://pypi.org/project/asgi-correlation-id/
+- https://gist.github.com/nymous/f138c7f06062b7c43c060bf03759c29e
+- https://github.com/sharu1204/fastapi-structlog/blob/master/app/main.py
+
+## Related Projects
+
+* https://github.com/underyx/structlog-pretty
+* https://pypi.org/project/httpx-structlog/
+
+## References
+
+- https://github.com/replicate/cog/blob/2e57549e18e044982bd100e286a1929f50880383/python/cog/logging.py#L20
+- https://github.com/apache/airflow/blob/4280b83977cd5a53c2b24143f3c9a6a63e298acc/task_sdk/src/airflow/sdk/log.py#L187
+- https://github.com/kiwicom/structlog-sentry
+- https://github.com/jeremyh/datacube-explorer/blob/b289b0cde0973a38a9d50233fe0fff00e8eb2c8e/cubedash/logs.py#L40C21-L40C42

structlog_config-0.1.0/copier.yml

@@ -0,0 +1,68 @@
+# NOTE some limitations of copier:
+#
+#   - any extensions must be installed manually
+#   - you cannot use dst_path as default answers
+
+_min_copier_version: 9.4.1
+
+_answers_file: .copier/.copier-answers.yml
+
+_jinja_extensions:
+  - jinja2_shell_extension.ShellExtension
+
+_message_after_copy: |
+  Next steps:
+
+    1. Customize secrets in .envrc
+    2. Run `direnv allow`
+    3. Set PYPI_API_TOKEN on GH actions
+    4. Set GH_TOKEN on GH actions
+
+project_name:
+  type: str
+  help: Dash separated project slug
+  default: "{{ \"basename $(pwd)\" | shell() | trim | regex_replace(' ', '-') | regex_replace('_', '-') }}"
+  validator: >-
+    {% if not (project_name | regex_search('^[a-z][a-z0-9-_]+$')) %}
+    project_name must start with a letter, followed one or more letters, digits or dashes all lowercase.
+    {% endif %}
+
+# https://github.com/superlinear-ai/substrate/blob/main/copier.yml
+project_name_snake_case:
+  when: false
+  default: "{{ project_name | lower | replace('-', '_') }}"
+
+full_name:
+  type: str
+  help: Full name of the project owner (for pypi)
+  default: "{{ \"git config --global user.name\" | shell() | trim }}"
+
+email:
+  type: str
+  help: Email of the project owner (for pypi)
+  default: "{{ \"git config --global user.email\" | shell() | trim }}"
+
+github_username:
+  type: str
+  help: GitHub username of the project owner (for pypi)
+  default: "{{ \"gh api user --jq '.login'\" | shell() | trim }}"
+
+_exclude:
+  - TODO
+  - /.git
+  - /README.md
+  - /CHANGELOG.md
+  - /LICENSE
+  - /uv.lock
+  - /metadata.json
+
+_tasks:
+  - '[ ! -d .git ] && git init'
+  - touch README.md
+  - uv sync
+  - git add -A
+  - git commit -m "🎉 Initial commit"
+  # - ["{{ _copier_python }}", .copier/bootstrap.py]
+
+# although it's annoying to have the .copier-answers.yml file in the root, it allows `copier update`
+# to work properly

structlog_config-0.1.0/pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+name = "structlog-config"
+version = "0.1.0"
+description = "A comprehensive structlog configuration with sensible defaults for development and production environments, featuring context management, exception formatting, and path prettification."
+keywords = ["logging", "structlog", "json-logging", "structured-logging"]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "orjson>=3.10.15",
+    "python-decouple-typed>=3.11.0",
+    "structlog>=25.2.0",
+]
+authors = [{ name = "Michael Bianco", email = "mike@mikebian.co" }]
+urls = { "Repository" = "https://github.com/iloveitaly/structlog-config" }
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+debugging-extras = [
+    "colorama>=0.4.6",
+    "datamodel-code-generator>=0.28.5",
+    "debugpy>=1.8.13",
+    "docrepr>=0.2.0",
+    "funcy-pipe>=0.11.1",
+    "httpdbg>=1.1.2",
+    "icecream>=2.1.4",
+    "ipdb",
+    "ipython>=8.34.0",
+    "ipython-autoimport>=0.5.1",
+    "ipython-ctrlr-fzf>=0.2.1",
+    "ipython-playground>=0.2.0",
+    "ipython-suggestions",
+    "ipythonclipboard>=1.0b2",
+    "jedi>=0.19.2",
+    "pdbr[ipython]>=0.9.0",
+    "pipdeptree>=2.26.0",
+    "pre-commit>=4.2.0",
+    "pretty-traceback",
+    "pudb>=2024.1.3",
+    "py-spy>=0.4.0",
+    "pyfzf>=0.3.1",
+    "pytest-fzf>=0.1.2.post1",
+    "rich>=14.0.0",
+    "rpdb>=0.2.0",
+    "sqlparse>=0.5.3",
+    "uv-development-toggle>=0.4.0",
+]
+dev = ["fastapi>=0.115.12", "httpx>=0.28.1", "pytest>=8.3.3"]
+
+[tool.uv.sources]
+ipdb = { git = "https://github.com/iloveitaly/ipdb", rev = "support-executables" }
+pdbr = { git = "https://github.com/iloveitaly/pdbr", rev = "ipython-9.x" }
+pretty-traceback = { git = "https://github.com/iloveitaly/pretty-traceback.git", rev = "custom" }
+ipython-suggestions = { git = "https://github.com/iloveitaly/ipython-suggestions.git", rev = "ipython-9.x" }