python-ppa 0.1.7__py3-none-any.whl → 0.1.9__py3-none-any.whl

{python_ppa-0.1.7.dist-info → python_ppa-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-ppa
-Version: 0.1.7
+Version: 0.1.9
 Summary: JPA-like ORM for Python
 Author: Pratyush Kumar
 License-Expression: MIT
@@ -14,7 +14,7 @@ Requires-Dist: idna==3.18
 Requires-Dist: pydantic==2.13.4
 Requires-Dist: pydantic_core==2.46.4
 Requires-Dist: psycopg[binary]>=3.2.0
-Requires-Dist: pymongo==4.17.0
+Requires-Dist: pymongo==4.18.1
 Requires-Dist: python-dotenv==1.2.2
 Requires-Dist: PyYAML==6.0.3
 Requires-Dist: typing-inspection==0.4.2
@@ -118,7 +118,109 @@ framework:
     level: "DEBUG"
 ```
 
-## 📖 Usage Example
+## PostgreSQL Quickstart
+
+The `demo/` folder contains a complete local PostgreSQL verification app.
+
+1. Start PostgreSQL:
+
+```bash
+cd demo
+docker compose up -d
+```
+
+2. Run the demo from the repository root:
+
+```bash
+./venv/bin/python demo/main.py
+```
+
+The demo creates a `users` table and verifies insert, convention queries, a custom SQL query, update, and delete through `ppa.postgres`.
+
+For your own app, create `resources/settings.yml`:
+
+```yaml
+app:
+  profile: ${APP_PROFILE:dev}
+```
+
+Then create `resources/settings-dev.yml`:
+
+```yaml
+postgresql:
+  host: ${POSTGRES_HOST:localhost}
+  port: ${POSTGRES_PORT:5432}
+  database: ${POSTGRES_DB_NAME:ppa_demo}
+  user: ${POSTGRES_USER:ppa_user}
+  password: ${POSTGRES_PASSWORD:ppa_password}
+
+framework:
+  logging:
+    enabled: true
+    level: DEBUG
+```
+
+You can also use a single DSN:
+
+```yaml
+postgresql:
+  dsn: ${POSTGRES_DSN:postgresql://ppa_user:ppa_password@localhost:5432/ppa_demo}
+```
+
+Create the database table before using the repository. `python-ppa` currently maps models to existing tables; it does not run migrations for you.
+
+```sql
+CREATE TABLE IF NOT EXISTS users (
+    id SERIAL PRIMARY KEY,
+    username TEXT NOT NULL UNIQUE,
+    email TEXT NOT NULL,
+    age INTEGER NOT NULL
+);
+```
+
+Define a PostgreSQL-backed entity and repository:
+
+```python
+from ppa.postgres import EntityModel, IRepository, query, table
+
+@table(name="users")
+class User(EntityModel):
+    username: str
+    email: str
+    age: int
+
+class UserRepository(IRepository[User]):
+    def find_by_username(self, username: str) -> User | None: ...
+    def exists_by_username(self, username: str) -> bool: ...
+    def count_by_age(self, age: int) -> int: ...
+    def find_all_by_age(self, age: int) -> list[User]: ...
+
+    @query("SELECT * FROM users WHERE email = ?0 AND age >= ?1")
+    def find_by_email_and_min_age(self, email: str, min_age: int) -> list[User]: ...
+```
+
+Use the repository:
+
+```python
+from ppa.config import close_db_connection
+
+repo = UserRepository()
+
+user_id = repo.save(User(username="pratyush", email="pratyush@example.com", age=25))
+user = repo.find_by_username("pratyush")
+
+print(user.model_dump() if user else None)
+print(repo.exists_by_username("pratyush"))
+print(repo.count_by_age(25))
+print(repo.find_by_email_and_min_age("pratyush@example.com", 21))
+
+repo.update(user_id, {"age": 26})
+repo.delete(user_id)
+
+close_db_connection()
+```
+
+## MongoDB Usage Example
 
 Here is a quick overview of how you can configure a domain entity and generate auto-implemented interface pipelines:
 
@@ -176,26 +278,6 @@ print(f"Found User: {user.email if user else 'Not Found'}")
 close_db_connection()
 ```
 
-PostgreSQL repositories follow the same naming conventions with SQL-backed models:
-
-```python
-from pydantic import EmailStr
-from ppa.postgres.interface import EntityModel, IRepository, query, table
-
-@table(name="users")
-class User(EntityModel):
-    username: str
-    email: EmailStr
-    age: int
-
-class UserRepository(IRepository[User]):
-    def find_by_username(self, username: str) -> User | None: ...
-    def count_by_age(self, age: int) -> int: ...
-
-    @query("SELECT * FROM users WHERE email = ?0 AND age >= ?1")
-    def find_by_email_and_min_age(self, email: str, min_age: int) -> list[User]: ...
-```
-
 ## 📜 License
 
 This project is open-source software licensed under the MIT License.

{python_ppa-0.1.7.dist-info → python_ppa-0.1.9.dist-info}/RECORD

@@ -4,8 +4,8 @@ ppa/mongo/__init__.py,sha256=tioeX330txLUWpEyAuj8rCO6C8DISjRkNFVDs8wGe54,168
 ppa/mongo/interface.py,sha256=lKDtd1KOXIjl9gKPGP_WVoKsE54_esJadNqKIHTadcw,12684
 ppa/postgres/__init__.py,sha256=6CsIXOIIANpCcLbDjQLvsatxcMwngmJagXtPzAznqc0,222
 ppa/postgres/interface.py,sha256=1wZqP1oChgI1m23zUQ8XXg79NQDXwaKX2JB53yYe8Tg,12829
-python_ppa-0.1.7.dist-info/licenses/LICENSE,sha256=J2MOuVHjIUNmdrDLa3O35gQz6E_wAJh9Ke3dod_ZDWc,1071
-python_ppa-0.1.7.dist-info/METADATA,sha256=U-_CItCF-VENHIKzEBvPshKDXpTNtu7HltmbAJW_egM,6226
-python_ppa-0.1.7.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-python_ppa-0.1.7.dist-info/top_level.txt,sha256=43G6at2pfqB1LsMChCc2_K8WwSSt-LoYBAYN6Sf-krk,4
-python_ppa-0.1.7.dist-info/RECORD,,
+python_ppa-0.1.9.dist-info/licenses/LICENSE,sha256=J2MOuVHjIUNmdrDLa3O35gQz6E_wAJh9Ke3dod_ZDWc,1071
+python_ppa-0.1.9.dist-info/METADATA,sha256=GyaV8mBamPm0HVJWz4dsCPNK-3pIyn4o-_PrqXf4aS8,8013
+python_ppa-0.1.9.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_ppa-0.1.9.dist-info/top_level.txt,sha256=43G6at2pfqB1LsMChCc2_K8WwSSt-LoYBAYN6Sf-krk,4
+python_ppa-0.1.9.dist-info/RECORD,,

{python_ppa-0.1.7.dist-info → python_ppa-0.1.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (83.0.0)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any