gpclog 0.2.0__tar.gz

gpclog-0.2.0/.github/workflows/python-publish.yml

@@ -0,0 +1,71 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://pypi.org/project/gpclog
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v5
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

gpclog-0.2.0/.gitignore

@@ -0,0 +1,197 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# git
+.git/
+.worktrees/
+
+# 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
+*.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
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# UV
+uv.lock
+
+# poetry
+poetry.lock
+poetry.toml
+
+# pdm
+pdm.lock
+pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+.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
+
+# 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
+.idea/
+
+# Abstra
+.abstra/
+
+# Visual Studio Code
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+.cursorignore
+.cursorindexingignore
+
+# Calude Code
+CLAUDE.md
+.claude/
+
+# OpenCode
+AGENTS.md
+.opencode/
+
+# Github Copilot
+.github/copilot-instructions.md
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# User drafts
+draft/
+dev_docs/
+
+# user progress
+PROGRESS.md
+progress.md
+
+# user ignore
+tests/mocks/log/

gpclog-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Linnet Codes <linnet.codes@gmail.com>
+
+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.

gpclog-0.2.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: gpclog
+Version: 0.2.0
+Summary: General Purpose Category Logger - A Python library for managing categorized logs in complex projects.
+Project-URL: Homepage, https://github.com/linnetcodes/gpclog
+Project-URL: Documentation, https://linnetcodes.github.io/gpclog
+Project-URL: Repository, https://github.com/linnetcodes/gpclog
+Project-URL: Issues, https://github.com/linnetcodes/gpclog/issues
+Author-email: Linnet Codes <linnet.codes@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: categorized-logging,gpconfig,logging,loguru,python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.10
+Requires-Dist: gpconfig>=0.3.0
+Requires-Dist: loguru>=0.7.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# gpclog
+
+[简体中文](README.zh-CN.md) | English
+
+General Purpose Category Logger - A Python library for managing categorized logs in complex projects.
+
+## Features
+
+- **Category-based Logging** - Each category has its own configuration and file
+- **Built on loguru** - High-performance, feature-rich logging core
+- **Built on gpconfig** - Type-safe configuration management
+- **Smart Defaults** - Works out of the box with zero configuration
+- **Auto Class Registration** - Automatically registers with GPConfigManager on import
+
+## Installation
+
+```bash
+pip install gpclog
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+import gpclog
+
+# Get a category logger (zero configuration)
+logger = gpclog.get_logger("my_category")
+logger.info("Hello, gpclog!")
+# Output to: ~/gpclog_output/my_category.log
+```
+
+### Using Configuration Files
+
+```python
+import gpclog
+from gpconfig import GPConfigManager
+
+# Initialize GPConfigManager (GPCLoggerConfig and GPCLogger are auto-registered)
+manager = GPConfigManager("myapp")
+
+# Method 1: Using gpclog public API
+logs_folder = manager.get_config("logs")
+gpclog.set_config_folder(logs_folder)
+logger = gpclog.get_logger("database")
+
+# Method 2: Using GPConfigManager directly
+logger = manager.get_object("logs.database")
+```
+
+Configuration schema, multiprocess usage, rotation/retention, and API details are documented in `docs/`.
+
+## Documentation
+
+Build and validate the documentation locally:
+
+```bash
+venv/bin/mkdocs build --clean --strict
+```
+
+Preview the documentation locally:
+
+```bash
+venv/bin/mkdocs serve
+```
+
+## API Reference
+
+See:
+
+- [Docs home](docs/index.md)
+- [gpclog module](docs/gpclog.md)
+- [GPCLogger](docs/logger.md)
+- [GPCLoggerConfig](docs/config.md)
+
+## License
+
+MIT

gpclog-0.2.0/README.md

@@ -0,0 +1,79 @@
+# gpclog
+
+[简体中文](README.zh-CN.md) | English
+
+General Purpose Category Logger - A Python library for managing categorized logs in complex projects.
+
+## Features
+
+- **Category-based Logging** - Each category has its own configuration and file
+- **Built on loguru** - High-performance, feature-rich logging core
+- **Built on gpconfig** - Type-safe configuration management
+- **Smart Defaults** - Works out of the box with zero configuration
+- **Auto Class Registration** - Automatically registers with GPConfigManager on import
+
+## Installation
+
+```bash
+pip install gpclog
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+import gpclog
+
+# Get a category logger (zero configuration)
+logger = gpclog.get_logger("my_category")
+logger.info("Hello, gpclog!")
+# Output to: ~/gpclog_output/my_category.log
+```
+
+### Using Configuration Files
+
+```python
+import gpclog
+from gpconfig import GPConfigManager
+
+# Initialize GPConfigManager (GPCLoggerConfig and GPCLogger are auto-registered)
+manager = GPConfigManager("myapp")
+
+# Method 1: Using gpclog public API
+logs_folder = manager.get_config("logs")
+gpclog.set_config_folder(logs_folder)
+logger = gpclog.get_logger("database")
+
+# Method 2: Using GPConfigManager directly
+logger = manager.get_object("logs.database")
+```
+
+Configuration schema, multiprocess usage, rotation/retention, and API details are documented in `docs/`.
+
+## Documentation
+
+Build and validate the documentation locally:
+
+```bash
+venv/bin/mkdocs build --clean --strict
+```
+
+Preview the documentation locally:
+
+```bash
+venv/bin/mkdocs serve
+```
+
+## API Reference
+
+See:
+
+- [Docs home](docs/index.md)
+- [gpclog module](docs/gpclog.md)
+- [GPCLogger](docs/logger.md)
+- [GPCLoggerConfig](docs/config.md)
+
+## License
+
+MIT

gpclog-0.2.0/README.zh-CN.md

@@ -0,0 +1,79 @@
+# gpclog
+
+简体中文 | [English](README.md)
+
+General Purpose Category Logger - 用于在复杂 Python 项目里管理分类日志。
+
+## 特性
+
+- **分类日志管理** - 每个日志类别独立配置、独立文件
+- **基于 loguru** - 高性能、功能丰富的日志核心
+- **基于 gpconfig** - 类型安全的配置管理
+- **智能默认配置** - 零配置即可使用
+- **自动类注册** - 导入即自动注册到 GPConfigManager
+
+## 安装
+
+```bash
+pip install gpclog
+```
+
+## 快速开始
+
+### 基本使用
+
+```python
+import gpclog
+
+# 获取一个分类日志器（零配置）
+logger = gpclog.get_logger("my_category")
+logger.info("Hello, gpclog!")
+# 输出到: ~/gpclog_output/my_category.log
+```
+
+### 使用配置文件
+
+```python
+import gpclog
+from gpconfig import GPConfigManager
+
+# 初始化 GPConfigManager（GPCLoggerConfig 和 GPCLogger 已自动注册）
+manager = GPConfigManager("myapp")
+
+# 方式 1：使用 gpclog 公共 API
+logs_folder = manager.get_config("logs")
+gpclog.set_config_folder(logs_folder)
+logger = gpclog.get_logger("database")
+
+# 方式 2：使用 GPConfigManager 直接创建
+logger = manager.get_object("logs.database")
+```
+
+配置结构、多进程用法、轮转/保留策略以及完整 API 说明请查看 `docs/`。
+
+## 文档
+
+本地构建并校验文档：
+
+```bash
+venv/bin/mkdocs build --clean --strict
+```
+
+本地预览文档：
+
+```bash
+venv/bin/mkdocs serve
+```
+
+## API 参考
+
+详见：
+
+- [文档首页](docs/zh/index.md)
+- [gpclog 模块](docs/zh/gpclog.md)
+- [GPCLogger 类](docs/zh/logger.md)
+- [GPCLoggerConfig 类](docs/zh/config.md)
+
+## 许可证
+
+MIT