1- # LogWard Python SDK
1+ # LogTide Python SDK
22
3- Official Python SDK for LogWard with advanced features: automatic batching, retry logic, circuit breaker, query API, live streaming, and middleware support.
3+ Official Python SDK for LogTide with advanced features: automatic batching, retry logic, circuit breaker, query API, live streaming, and middleware support.
44
55## Features
66
@@ -25,34 +25,34 @@ Official Python SDK for LogWard with advanced features: automatic batching, retr
2525## Installation
2626
2727``` bash
28- pip install logward -sdk
28+ pip install logtide -sdk
2929```
3030
3131### Optional dependencies
3232
3333``` bash
3434# For async support
35- pip install logward -sdk[async]
35+ pip install logtide -sdk[async]
3636
3737# For Flask middleware
38- pip install logward -sdk[flask]
38+ pip install logtide -sdk[flask]
3939
4040# For Django middleware
41- pip install logward -sdk[django]
41+ pip install logtide -sdk[django]
4242
4343# For FastAPI middleware
44- pip install logward -sdk[fastapi]
44+ pip install logtide -sdk[fastapi]
4545
4646# Install all extras
47- pip install logward -sdk[async,flask,django,fastapi]
47+ pip install logtide -sdk[async,flask,django,fastapi]
4848```
4949
5050## Quick Start
5151
5252``` python
53- from logward_sdk import LogWardClient , ClientOptions
53+ from logtide_sdk import LogTideClient , ClientOptions
5454
55- client = LogWardClient (
55+ client = LogTideClient (
5656 ClientOptions(
5757 api_url = ' http://localhost:8080' ,
5858 api_key = ' lp_your_api_key_here' ,
@@ -75,7 +75,7 @@ client.close()
7575
7676| Option | Type | Default | Description |
7777| --------| ------| ---------| -------------|
78- | ` api_url ` | ` str ` | ** required** | Base URL of your LogWard instance |
78+ | ` api_url ` | ` str ` | ** required** | Base URL of your LogTide instance |
7979| ` api_key ` | ` str ` | ** required** | Project API key (starts with ` lp_ ` ) |
8080| ` batch_size ` | ` int ` | ` 100 ` | Number of logs to batch before sending |
8181| ` flush_interval ` | ` int ` | ` 5000 ` | Interval in ms to auto-flush logs |
@@ -99,7 +99,7 @@ client.close()
9999``` python
100100import os
101101
102- client = LogWardClient (
102+ client = LogTideClient (
103103 ClientOptions(
104104 api_url = ' http://localhost:8080' ,
105105 api_key = ' lp_your_api_key_here' ,
@@ -143,7 +143,7 @@ client = LogWardClient(
143143### Basic Logging
144144
145145``` python
146- from logward_sdk import LogLevel
146+ from logtide_sdk import LogLevel
147147
148148client.debug(' service-name' , ' Debug message' )
149149client.info(' service-name' , ' Info message' , {' userId' : 123 })
@@ -222,7 +222,7 @@ Search and retrieve logs programmatically.
222222
223223``` python
224224from datetime import datetime, timedelta
225- from logward_sdk import QueryOptions, LogLevel
225+ from logtide_sdk import QueryOptions, LogLevel
226226
227227result = client.query(
228228 QueryOptions(
@@ -257,7 +257,7 @@ print(f"Trace has {len(logs)} logs")
257257
258258``` python
259259from datetime import datetime, timedelta
260- from logward_sdk import AggregatedStatsOptions
260+ from logtide_sdk import AggregatedStatsOptions
261261
262262stats = client.get_aggregated_stats(
263263 AggregatedStatsOptions(
@@ -329,19 +329,19 @@ Auto-log all HTTP requests and responses.
329329
330330``` python
331331from flask import Flask
332- from logward_sdk import LogWardClient , ClientOptions
333- from logward_sdk .middleware import LogWardFlaskMiddleware
332+ from logtide_sdk import LogTideClient , ClientOptions
333+ from logtide_sdk .middleware import LogTideFlaskMiddleware
334334
335335app = Flask(__name__ )
336336
337- client = LogWardClient (
337+ client = LogTideClient (
338338 ClientOptions(
339339 api_url = ' http://localhost:8080' ,
340340 api_key = ' lp_your_api_key_here' ,
341341 )
342342)
343343
344- LogWardFlaskMiddleware (
344+ LogTideFlaskMiddleware (
345345 app,
346346 client = client,
347347 service_name = ' flask-api' ,
@@ -361,38 +361,38 @@ LogWardFlaskMiddleware(
361361``` python
362362# settings.py
363363MIDDLEWARE = [
364- ' logward_sdk .middleware.LogWardDjangoMiddleware ' ,
364+ ' logtide_sdk .middleware.LogTideDjangoMiddleware ' ,
365365]
366366
367- from logward_sdk import LogWardClient , ClientOptions
367+ from logtide_sdk import LogTideClient , ClientOptions
368368
369- LOGWARD_CLIENT = LogWardClient (
369+ LOGTIDE_CLIENT = LogTideClient (
370370 ClientOptions(
371371 api_url = ' http://localhost:8080' ,
372372 api_key = ' lp_your_api_key_here' ,
373373 )
374374)
375- LOGWARD_SERVICE_NAME = ' django-api'
375+ LOGTIDE_SERVICE_NAME = ' django-api'
376376```
377377
378378### FastAPI Middleware
379379
380380``` python
381381from fastapi import FastAPI
382- from logward_sdk import LogWardClient , ClientOptions
383- from logward_sdk .middleware import LogWardFastAPIMiddleware
382+ from logtide_sdk import LogTideClient , ClientOptions
383+ from logtide_sdk .middleware import LogTideFastAPIMiddleware
384384
385385app = FastAPI()
386386
387- client = LogWardClient (
387+ client = LogTideClient (
388388 ClientOptions(
389389 api_url = ' http://localhost:8080' ,
390390 api_key = ' lp_your_api_key_here' ,
391391 )
392392)
393393
394394app.add_middleware(
395- LogWardFastAPIMiddleware ,
395+ LogTideFastAPIMiddleware ,
396396 client = client,
397397 service_name = ' fastapi-api' ,
398398)
@@ -413,11 +413,11 @@ See the [examples/](./examples) directory for complete working examples:
413413
414414## API Reference
415415
416- ### LogWardClient
416+ ### LogTideClient
417417
418418#### Constructor
419419``` python
420- client = LogWardClient (options: ClientOptions)
420+ client = LogTideClient (options: ClientOptions)
421421```
422422
423423#### Logging Methods
@@ -468,7 +468,7 @@ atexit.register(client.close)
468468### 2. Use Global Metadata
469469
470470``` python
471- client = LogWardClient (
471+ client = LogTideClient (
472472 ClientOptions(
473473 api_url = ' http://localhost:8080' ,
474474 api_key = ' lp_your_api_key_here' ,
@@ -484,7 +484,7 @@ client = LogWardClient(
484484### 3. Enable Debug Mode in Development
485485
486486``` python
487- client = LogWardClient (
487+ client = LogTideClient (
488488 ClientOptions(
489489 api_url = ' http://localhost:8080' ,
490490 api_key = ' lp_your_api_key_here' ,
@@ -524,8 +524,8 @@ monitor_thread.start()
524524
525525``` bash
526526# Clone repository
527- git clone https://github.com/logward-dev/logward -sdk-python .git
528- cd logward -sdk-python
527+ git clone https://github.com/logtide/python -sdk.git
528+ cd logtide -sdk-python
529529
530530# Create virtual environment
531531python -m venv venv
@@ -542,13 +542,13 @@ pip install -e ".[dev]"
542542pytest tests/
543543
544544# Type checking
545- mypy logward_sdk /
545+ mypy logtide_sdk /
546546
547547# Code formatting
548- black logward_sdk / tests/ examples/
548+ black logtide_sdk / tests/ examples/
549549
550550# Linting
551- ruff check logward_sdk /
551+ ruff check logtide_sdk /
552552```
553553
554554---
@@ -561,11 +561,11 @@ MIT
561561
562562## Contributing
563563
564- Contributions are welcome! Please open an issue or PR on [ GitHub] ( https://github.com/logward-dev/logward -sdk-python ) .
564+ Contributions are welcome! Please open an issue or PR on [ GitHub] ( https://github.com/logtide/python -sdk ) .
565565
566566---
567567
568568## Support
569569
570- - ** Documentation** : [ https://logward .dev/docs ] ( https://logward .dev/docs )
571- - ** Issues** : [ GitHub Issues] ( https://github.com/logward-dev/logward -sdk-python /issues )
570+ - ** Documentation** : [ https://logtide .dev/docs ] ( https://logtide .dev/docs )
571+ - ** Issues** : [ GitHub Issues] ( https://github.com/logtide/python -sdk/issues )
0 commit comments