sqlalchemy-studio 0.1.6__tar.gz → 0.1.8__tar.gz

sqlalchemy_studio-0.1.8/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: sqlalchemy-studio
+Version: 0.1.8
+Summary: FastAPI studio for inspecting SQLAlchemy databases
+Author-email: Xursand Qarlibayev <coderxuz2009@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/coderxuz/sqlalchemy-studio
+Project-URL: Source, https://github.com/coderxuz/sqlalchemy-studio
+Keywords: sqlalchemy,database,inspector,studio
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: build>=1.5.0
+Requires-Dist: fastapi>=0.136.3
+Requires-Dist: sqlalchemy>=2.0.50
+Requires-Dist: twine>=6.2.0
+Requires-Dist: uvicorn>=0.48.0
+
+# sqlalchemy-studio
+
+FastAPI studio for inspecting and querying SQLAlchemy databases.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install sqlalchemy-studio
+```
+
+Or install the latest version from GitHub:
+
+```bash
+pip install --upgrade git+https://github.com/coderxuz/sqlalchemy-studio.git@main#subdirectory=sqlalchemy-studio-backend
+```
+
+## Usage
+
+Create a normal SQLAlchemy engine and declarative base, then pass them to `Studio`.
+
+```python
+from sqlalchemy import Integer, String, create_engine
+from sqlalchemy.orm import DeclarativeBase, Mapped, Session, mapped_column
+
+from sqlalchemy_studio import Studio
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+class User(Base):
+    __tablename__ = "users"
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
+    username: Mapped[str] = mapped_column(String(50), nullable=False)
+    email: Mapped[str] = mapped_column(String(120), nullable=False)
+
+
+engine = create_engine("sqlite:///app.db")
+
+
+def seed_data() -> None:
+    Base.metadata.create_all(engine)
+
+    with Session(engine) as session:
+        if session.query(User).count() == 0:
+            session.add_all(
+                [
+                    User(username="john", email="john@example.com"),
+                    User(username="alice", email="alice@example.com"),
+                ]
+            )
+            session.commit()
+
+
+if __name__ == "__main__":
+    seed_data()
+    Studio(engine=engine, base=Base).run(port=7000)
+```
+
+Run the script:
+
+```bash
+python app.py
+```
+
+Open `http://localhost:7000` in your browser.
+
+
+
+![Example dashboard](image.png)

sqlalchemy_studio-0.1.8/README.md

@@ -0,0 +1,74 @@
+# sqlalchemy-studio
+
+FastAPI studio for inspecting and querying SQLAlchemy databases.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install sqlalchemy-studio
+```
+
+Or install the latest version from GitHub:
+
+```bash
+pip install --upgrade git+https://github.com/coderxuz/sqlalchemy-studio.git@main#subdirectory=sqlalchemy-studio-backend
+```
+
+## Usage
+
+Create a normal SQLAlchemy engine and declarative base, then pass them to `Studio`.
+
+```python
+from sqlalchemy import Integer, String, create_engine
+from sqlalchemy.orm import DeclarativeBase, Mapped, Session, mapped_column
+
+from sqlalchemy_studio import Studio
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+class User(Base):
+    __tablename__ = "users"
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
+    username: Mapped[str] = mapped_column(String(50), nullable=False)
+    email: Mapped[str] = mapped_column(String(120), nullable=False)
+
+
+engine = create_engine("sqlite:///app.db")
+
+
+def seed_data() -> None:
+    Base.metadata.create_all(engine)
+
+    with Session(engine) as session:
+        if session.query(User).count() == 0:
+            session.add_all(
+                [
+                    User(username="john", email="john@example.com"),
+                    User(username="alice", email="alice@example.com"),
+                ]
+            )
+            session.commit()
+
+
+if __name__ == "__main__":
+    seed_data()
+    Studio(engine=engine, base=Base).run(port=7000)
+```
+
+Run the script:
+
+```bash
+python app.py
+```
+
+Open `http://localhost:7000` in your browser.
+
+
+
+![Example dashboard](image.png)

{sqlalchemy_studio-0.1.6 → sqlalchemy_studio-0.1.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sqlalchemy-studio"
-version = "0.1.6"
+version = "0.1.8"
 description = "FastAPI studio for inspecting SQLAlchemy databases"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -34,4 +34,4 @@ urls = { "Homepage" = "https://github.com/coderxuz/sqlalchemy-studio", "Source"
 include = ["studio*", "sqlalchemy_studio*"]
 
 [tool.setuptools.package-data]
-studio = ["static/**/*"]
+sqlalchemy_studio = ["static/**/*"]

{sqlalchemy_studio-0.1.6 → sqlalchemy_studio-0.1.8}/sqlalchemy_studio/Studio.py

@@ -74,6 +74,7 @@ class Studio:
     def _register_routes(self):
         self.app.include_router(create_tables_router(self))
         static_dir = files("sqlalchemy_studio").joinpath("static")
+        
         if static_dir.is_dir():
             self.app.mount(
                 "/",