logwell 0.1.0__tar.gz

logwell-0.1.0/.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

logwell-0.1.0/LICENSE

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

logwell-0.1.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: logwell
+Version: 0.1.0
+Summary: Official Python SDK for Logwell logging platform
+Project-URL: Homepage, https://github.com/Divkix/Logwell
+Project-URL: Documentation, https://github.com/Divkix/Logwell/tree/main/sdks/python#readme
+Project-URL: Repository, https://github.com/Divkix/Logwell
+Project-URL: Issues, https://github.com/Divkix/Logwell/issues
+Author-email: Divkix <divkix@divkix.me>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: logging,logs,logwell,observability,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: typing-extensions>=4.0.0
+Provides-Extra: dev
+Requires-Dist: coverage[toml]>=7.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Logwell Python SDK
+
+Official Python SDK for the [Logwell](https://github.com/Divkix/Logwell) logging platform.
+
+## Installation
+
+```bash
+pip install logwell
+```
+
+## Quick Start
+
+```python
+import asyncio
+from logwell import Logwell
+
+# Initialize client
+client = Logwell({
+    'api_key': 'lw_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+    'endpoint': 'https://logs.example.com',
+    'service': 'my-app',
+})
+
+# Log messages at different levels
+client.debug('Debug message')
+client.info('User logged in', {'user_id': '123'})
+client.warn('Disk space low', {'available_gb': 5})
+client.error('Failed to process request', {'request_id': 'abc'})
+client.fatal('Database connection lost')
+
+# Ensure logs are sent before exit
+asyncio.run(client.shutdown())
+```
+
+## Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `api_key` | `str` | **required** | API key in format `lw_[32 chars]` |
+| `endpoint` | `str` | **required** | Logwell server URL |
+| `service` | `str` | `None` | Default service name for all logs |
+| `batch_size` | `int` | `50` | Number of logs to batch before auto-flush |
+| `flush_interval` | `float` | `5.0` | Seconds between auto-flushes |
+| `max_queue_size` | `int` | `1000` | Maximum queue size before dropping oldest |
+| `max_retries` | `int` | `3` | Retry attempts for failed requests |
+| `capture_source_location` | `bool` | `False` | Capture file/line info |
+| `on_error` | `Callable` | `None` | Error callback |
+| `on_flush` | `Callable` | `None` | Flush callback |
+
+### Example with all options
+
+```python
+from logwell import Logwell
+
+def on_error(err):
+    print(f'Logging error: {err}')
+
+def on_flush(count):
+    print(f'Flushed {count} logs')
+
+client = Logwell({
+    'api_key': 'lw_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+    'endpoint': 'https://logs.example.com',
+    'service': 'my-app',
+    'batch_size': 100,
+    'flush_interval': 10.0,
+    'max_queue_size': 5000,
+    'max_retries': 5,
+    'capture_source_location': True,
+    'on_error': on_error,
+    'on_flush': on_flush,
+})
+```
+
+## API Reference
+
+### Logwell
+
+The main client class.
+
+#### Constructor
+
+```python
+Logwell(config: LogwellConfig)
+```
+
+#### Methods
+
+| Method | Description |
+|--------|-------------|
+| `debug(message, metadata=None)` | Log at debug level |
+| `info(message, metadata=None)` | Log at info level |
+| `warn(message, metadata=None)` | Log at warning level |
+| `error(message, metadata=None)` | Log at error level |
+| `fatal(message, metadata=None)` | Log at fatal level |
+| `log(entry)` | Log with explicit LogEntry |
+| `flush()` | Async: Flush queued logs immediately |
+| `shutdown()` | Async: Flush and stop the client |
+| `child(metadata=None, service=None)` | Create child logger with context |
+| `queue_size` | Property: Current queue size |
+
+### Child Loggers
+
+Create child loggers to add persistent context:
+
+```python
+# Create child logger with request context
+request_logger = client.child({'request_id': 'abc-123'})
+request_logger.info('Processing request')  # Includes request_id
+
+# Override service name
+db_logger = client.child(service='my-app-db')
+db_logger.info('Query executed', {'duration_ms': 45})
+```
+
+### Log Entry
+
+```python
+from logwell import LogLevel
+
+# Using log() with explicit entry
+client.log({
+    'level': 'info',
+    'message': 'Custom log',
+    'metadata': {'key': 'value'},
+    'service': 'override-service',
+    'timestamp': '2024-01-01T00:00:00Z',  # Optional, auto-generated
+})
+```
+
+### LogLevel
+
+Available log levels: `debug`, `info`, `warn`, `error`, `fatal`
+
+### LogwellConfig
+
+TypedDict with configuration options. See Configuration section above.
+
+### IngestResponse
+
+Response from the server after flushing logs:
+
+```python
+{
+    'accepted': 50,      # Logs accepted
+    'rejected': 0,       # Logs rejected (optional)
+    'errors': [],        # Error messages (optional)
+}
+```
+
+## Error Handling
+
+### LogwellError
+
+All SDK errors are wrapped in `LogwellError`:
+
+```python
+from logwell import Logwell, LogwellError, LogwellErrorCode
+
+try:
+    client = Logwell({'api_key': 'invalid', 'endpoint': 'https://example.com'})
+except LogwellError as e:
+    print(e.message)      # Human-readable message
+    print(e.code)         # LogwellErrorCode enum
+    print(e.status_code)  # HTTP status (if applicable)
+    print(e.retryable)    # Whether operation can be retried
+```
+
+### Error Codes
+
+| Code | Description |
+|------|-------------|
+| `INVALID_CONFIG` | Invalid configuration value |
+| `NETWORK_ERROR` | Network connectivity or timeout |
+| `UNAUTHORIZED` | Invalid or expired API key (401) |
+| `VALIDATION_ERROR` | Invalid request data |
+| `RATE_LIMITED` | Too many requests (429) |
+| `SERVER_ERROR` | Server-side error (5xx) |
+| `QUEUE_OVERFLOW` | Queue exceeded max size |
+
+### Error Callback
+
+Handle errors without try/catch:
+
+```python
+def handle_error(err: Exception):
+    if isinstance(err, LogwellError):
+        if err.code == LogwellErrorCode.NETWORK_ERROR:
+            print('Network issue, logs will be retried')
+        elif err.code == LogwellErrorCode.QUEUE_OVERFLOW:
+            print('Queue full, some logs dropped')
+
+client = Logwell({
+    'api_key': 'lw_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+    'endpoint': 'https://logs.example.com',
+    'on_error': handle_error,
+})
+```
+
+## Async Usage
+
+The SDK uses async for flush and shutdown operations:
+
+```python
+import asyncio
+from logwell import Logwell
+
+async def main():
+    client = Logwell({
+        'api_key': 'lw_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+        'endpoint': 'https://logs.example.com',
+    })
+
+    client.info('Starting app')
+
+    # Manual flush
+    response = await client.flush()
+    print(f'Sent {response["accepted"]} logs')
+
+    # Shutdown gracefully
+    await client.shutdown()
+
+asyncio.run(main())
+```
+
+## Source Location Capture
+
+Enable automatic file/line capture:
+
+```python
+client = Logwell({
+    'api_key': 'lw_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa',
+    'endpoint': 'https://logs.example.com',
+    'capture_source_location': True,
+})
+
+client.info('This log includes file and line number')
+# Log includes: source_file='app.py', line_number=42
+```
+
+## Requirements
+
+- Python 3.9+
+- httpx >= 0.25.0
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.