GoodbyeSQL 0.5__py3-none-any.whl → 0.5.3__py3-none-any.whl

goodbyesql/__init__.py

@@ -1,3 +1,10 @@
 # __init__.py
-from .main import GoodbyeSQL
-from .config import GoodbyeSQLConfig
+from goodbyesql.main import GoodbyeSQL
+from goodbyesql.config import GoodbyeSQLConfig
+from goodbyesql.registry import set_session_provider
+
+__all__ = [
+    "GoodbyeSQL",
+    "GoodbyeSQLConfig",
+    "set_session_provider"
+]

goodbyesql/config.py

@@ -1,10 +1,15 @@
 from dataclasses import dataclass
 from typing import Any
+from pydantic_settings import BaseSettings
+from typing import List, Annotated
+from sqlalchemy.ext.asyncio import AsyncSession
+from fastapi import Depends
+from goodbyesql.registry import get_session
 
 
 @dataclass
-class GoodbyeSQLConfig:
-    user_model: any
+class GoodbyeSQLConfig(BaseSettings):
+    user_model: List[str]
     username_field: str = 'username'
 
     

goodbyesql/main.py

@@ -1,13 +1,18 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy import select
-from config import GoodbyeSQLConfig
+from goodbyesql.config import GoodbyeSQLConfig
+from typing import Annotated
+from fastapi import Depends
+from goodbyesql.registry import get_session
+
+DB_Session = Annotated[AsyncSession, Depends(get_session)]
 
 
 class GoodbyeSQL:
     def __init__(self, config: GoodbyeSQLConfig):
         self.config = config
 
-    async def get_info_by_username(self, *, session: AsyncSession, username: str):
+    async def get_info_by_username(self, *, session: DB_Session, username: str):
 
         model = self.config.user_model
         field = getattr(model,self.config.username_field)
@@ -15,6 +20,7 @@ class GoodbyeSQL:
         query = select(model).where(field == username)
         result = await session.execute(query)
         user: None = result.scalar_one_or_none()
+        return user
 
 
 

goodbyesql/registry.py

@@ -0,0 +1,17 @@
+from typing import Callable, Optional
+
+_session_provider : Optional[Callable] = None
+
+def set_session_provider(provider: Callable) -> None:
+    global _session_provider
+
+    _session_provider = provider
+
+def get_session():
+    if _session_provider is None:
+        RuntimeError(
+            "Session have not been set up yet."
+            "You can set your session via set_session_provider function!"
+        )
+
+    return _session_provider()

goodbyesql-0.5.3.dist-info/METADATA

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: GoodbyeSQL
+Version: 0.5.3
+Description-Content-Type: text/markdown
+Requires-Dist: sqlalchemy==2.0.43
+Requires-Dist: fastapi==0.135.1
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+
+# goodbyesql
+
+### Simplify SQLAlchemy. Say goodbye to repetitive database code.
+
+`goodbyesql` is a lightweight Python library built on top of **SQLAlchemy** that helps backend developers reduce repetitive database boilerplate.
+
+It provides a simple interface for working with common SQLAlchemy operations while keeping SQLAlchemy underneath.
+
+## ✨ Features
+
+* 🐍 Built for Python backend applications
+* 🗄️ Built on top of SQLAlchemy
+* ⚡ Simplifies common database operations
+* 🧹 Reduces repetitive SQLAlchemy boilerplate
+* ⚙️ Configurable database setup
+* 🔌 Custom session provider support
+
+## 📦 Installation
+
+```bash
+pip install goodbyesql
+```
+
+## 🚀 Quick Start
+
+```python
+from goodbyesql import GoodbyeSQL, GoodbyeSQLConfig
+
+config = GoodbyeSQLConfig(
+    # your configuration
+)
+
+db = GoodbyeSQL(config)
+```
+
+`GoodbyeSQL` provides a higher-level interface for common database operations while using SQLAlchemy internally.
+
+## 🔧 Session Provider
+
+`goodbyesql` also allows you to configure your own SQLAlchemy session provider:
+
+```python
+from goodbyesql import set_session_provider
+
+set_session_provider(your_session_provider)
+```
+
+This makes it possible to integrate `goodbyesql` into existing backend architectures where database sessions are already managed by the application.
+
+## 🏗️ How It Works
+
+`goodbyesql` is not a replacement for SQLAlchemy.
+
+Instead, it provides a convenient abstraction on top of it:
+
+```text
+┌─────────────────────┐
+│   Your Application  │
+└──────────┬──────────┘
+           │
+           ▼
+┌─────────────────────┐
+│     goodbyesql      │
+│  Simple DB API      │
+└──────────┬──────────┘
+           │
+           ▼
+┌─────────────────────┐
+│      SQLAlchemy     │
+└──────────┬──────────┘
+           │
+           ▼
+┌─────────────────────┐
+│      Database       │
+└─────────────────────┘
+```
+
+The goal is simple:
+
+> **Write less repetitive database code and focus more on your application.**
+
+## 🎯 Who is it for?
+
+`goodbyesql` is designed primarily for **Python backend developers** who use SQLAlchemy and want a simpler way to handle common database functionality.
+
+It can be especially useful in projects such as:
+
+* REST APIs
+* FastAPI applications
+* Backend services
+* Automation systems
+* Microservices
+* Other Python applications using SQLAlchemy
+
+## 📚 Public API
+
+### `GoodbyeSQL`
+
+The main class used to work with `goodbyesql`.
+
+```python
+from goodbyesql import GoodbyeSQL
+```
+
+### `GoodbyeSQLConfig`
+
+Configuration for `GoodbyeSQL`.
+
+```python
+from goodbyesql import GoodbyeSQLConfig
+```
+
+### `set_session_provider`
+
+Configure the session provider used by `goodbyesql`.
+
+```python
+from goodbyesql import set_session_provider
+```
+
+## 🚧 Project Status
+
+`goodbyesql` is currently under active development.
+
+The API may change in future releases as the project evolves.
+
+Feedback, issues, and contributions are welcome.
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+Feel free to open an issue or submit a pull request if you have an idea, improvement, or bug fix.
+
+## 📄 License
+
+See the `LICENSE` file for license information.

goodbyesql-0.5.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+goodbyesql/__init__.py,sha256=Vb66UPBqSUh9VaiuvPIl-i_t5LU033OSMDvuDKvD6NI,245
+goodbyesql/config.py,sha256=tFAx_aWD-mTCatEU50mK55XDvA0cCU-zQueeibQgHrg,392
+goodbyesql/main.py,sha256=NmN98x_4kD2OTvupQhPhNvSXkPVY9O9UiVwmvqOCoiw,835
+goodbyesql/registry.py,sha256=IZ1oJBu3H7nkKfhAr7showUXQjyzeTAgFAvqk-qPqPo,460
+goodbyesql-0.5.3.dist-info/METADATA,sha256=6hn6Z9zDU2bKk_zPXUIpg1IdPfUcu92nZRauASnj3Oo,3895
+goodbyesql-0.5.3.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+goodbyesql-0.5.3.dist-info/entry_points.txt,sha256=HJZv1j9H1L-XcIje9b7p4wQLzWB-u4VSGj9zm2b0zqQ,52
+goodbyesql-0.5.3.dist-info/top_level.txt,sha256=RKJnBiGErKfK2KnnHs8AXbl8Vk7JSMu_Oozegzplb6E,11
+goodbyesql-0.5.3.dist-info/RECORD,,

goodbyesql-0.5.dist-info/METADATA

@@ -1,5 +0,0 @@
-Metadata-Version: 2.4
-Name: GoodbyeSQL
-Version: 0.5
-Requires-Dist: sqlalchemy==2.0.43
-Dynamic: requires-dist

goodbyesql-0.5.dist-info/RECORD

@@ -1,8 +0,0 @@
-goodbyesql/__init__.py,sha256=4hJuTgjbpk-m6nLWDHGdDgF0Lf83Ih_56OpFsaISkPM,81
-goodbyesql/config.py,sha256=j9pIFKPHZzkgokCNsjWbXntIdA7kSgKqYHqP-og_FYE,169
-goodbyesql/main.py,sha256=Abxg-ozex_t7reQJ31z-reGw3xLeNICi_VPNyr7D7iA,639
-goodbyesql-0.5.dist-info/METADATA,sha256=fnmoMrp9vfYI0gxtpqDk32ZmmbByRD0EqiE-XSuC1Fc,114
-goodbyesql-0.5.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-goodbyesql-0.5.dist-info/entry_points.txt,sha256=HJZv1j9H1L-XcIje9b7p4wQLzWB-u4VSGj9zm2b0zqQ,52
-goodbyesql-0.5.dist-info/top_level.txt,sha256=RKJnBiGErKfK2KnnHs8AXbl8Vk7JSMu_Oozegzplb6E,11
-goodbyesql-0.5.dist-info/RECORD,,