From 974d8371ed3175ab61807549f24554c91e6b40fb Mon Sep 17 00:00:00 2001 From: Alexander Belikov Date: Thu, 1 May 2025 23:10:50 +0200 Subject: [PATCH] update docs --- README.md | 5 ++++- docs/examples.md | 9 ++++----- docs/index.md | 6 +++--- pyproject.toml | 2 +- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e985302..549a8e5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# SUThing +# SUThing suthing logo SUThing /ˈsu.θɪŋ/ or /ˈsʌ.θɪŋ/ (Some Useful Things) is a collection of useful classes and decorators. @@ -17,6 +17,9 @@ A Python utility package providing tools for file handling, timing, profiling, a - **Data Comparison**: Deep comparison of nested data structures - **Error Handling**: Decorators for secure function execution and error tracking +## Documentation +Full documentation is available at: [growgraph.github.io/suthing](https://growgraph.github.io/suthing) + ## Installation ```bash diff --git a/docs/examples.md b/docs/examples.md index 312bd77..6c472cb 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -8,12 +8,11 @@ Load and manage configuration files with automatic format detection: ```python from suthing import FileHandle -from pathlib import Path # Load configuration from different formats config = FileHandle.load("config.yaml") env_vars = FileHandle.load(".env") -credentials = FileHandle.load("secrets.json") +df = FileHandle.load("secrets.csv") # Save configuration with compression FileHandle.dump(config, "config.json.gz") @@ -55,17 +54,17 @@ Create and manage database connections with automatic type detection: from suthing.connection import ConfigFactory # ArangoDB connection -arango_config = ConfigFactory.create_config(url="http://localhost:8529") +arango_config = ConfigFactory.create_config("http://localhost:8529") # Neo4j connection -neo4j_config = ConfigFactory.create_config(dict_like={ +neo4j_config = ConfigFactory.create_config({ "port": "7474", "username": "neo4j", "password": "password" }) # WSGI application -wsgi_config = ConfigFactory.create_config(dict_like={ +wsgi_config = ConfigFactory.create_config({ "port": "8000", "host": "0.0.0.0", "path": "/api" diff --git a/docs/index.md b/docs/index.md index 17fe088..0ef5322 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,8 @@ A Python utility package providing tools for file handling, timing, profiling, a ## Features -- **File Handling**: one-line file reading/writing with file format inference from provided extension (YAML, JSON, CSV, pickle, gz etc.) +- **File Handling**: One-line file reading/writing with file format inference from provided extension (YAML, JSON, CSV, pickle, gz etc.) +- **API/Database Config Class**: Normalized representation of API connection configs - **Performance Measurement**: Simple timer utilities and profiling decorators - **Data Comparison**: Deep comparison of nested data structures - **Error Handling**: Decorators for secure function execution and error tracking @@ -21,7 +22,7 @@ A Python utility package providing tools for file handling, timing, profiling, a ## Quick Start ```python -from suthing import FileHandle, Timer, profile, equals +from suthing import FileHandle, Timer, equals # Read a file data = FileHandle.load("config.yaml") @@ -41,7 +42,6 @@ result = equals(dict1, dict2) Explore the documentation to learn more about Suthing's features: - [Getting Started](getting_started/quickstart.md) - Learn how to install and use Suthing - - [API Reference](reference/index.md) - Complete API documentation - [Examples](examples.md) - Code examples and usage patterns diff --git a/pyproject.toml b/pyproject.toml index 123571f..485523c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,7 +9,7 @@ dev = [ "setuptools>=80.1.0" ] docs = [ - "mkdocs-material>=9.6.12", + "mkdocs-material", "mkdocs>=1.6.1", "mkdocstrings[python]>=0.29.1" ]