Metadata-Version: 2.1
Name: sqladmin
Version: 0.1.5
Summary: Admin interface for SQLAlchemy.
Home-page: https://github.com/aminalaee/sqladmin
Author: Amin Alaee
Author-email: mohammadamin.alaee@gmail.com
License: BSD
Description: <p align="center">
        <a href="https://github.com/aminalaee/sqladmin">
            <img width="400px" src="https://raw.githubusercontent.com/aminalaee/sqladmin/main/docs/assets/images/banner.png" alt"SQLAdmin">
        </a>
        </p>
        
        <p align="center">
        <a href="https://github.com/aminalaee/sqladmin/actions">
            <img src="https://github.com/aminalaee/sqladmin/workflows/Test%20Suite/badge.svg" alt="Build Status">
        </a>
        <a href="https://github.com/aminalaee/sqladmin/actions">
            <img src="https://github.com/aminalaee/sqladmin/workflows/Publish/badge.svg" alt="Publish Status">
        </a>
        <a href="https://codecov.io/gh/aminalaee/sqladmin">
            <img src="https://codecov.io/gh/aminalaee/sqladmin/branch/main/graph/badge.svg" alt="Coverage">
        </a>
        <a href="https://pypi.org/project/sqladmin/">
            <img src="https://badge.fury.io/py/sqladmin.svg" alt="Package version">
        </a>
        <a href="https://pypi.org/project/sqladmin" target="_blank">
            <img src="https://img.shields.io/pypi/pyversions/sqladmin.svg?color=%2334D058" alt="Supported Python versions">
        </a>
        </p>
        
        ---
        
        # SQLAlchemy Admin for Starlette/FastAPI
        
        SQLAdmin is a flexible Admin interface for SQLAlchemy models.
        
        Main features include:
        
        * SQLAlchemy sync/async engines
        * [Starlette](https://github.com/encode/starlette) integration
        * [FastAPI](https://github.com/tiangolo/fastapi) integration
        * Modern UI using [Tabler](https://github.com/tabler/tabler)
        
        ---
        
        **Documentation**: [https://aminalaee.github.io/sqladmin](https://aminalaee.github.io/sqladmin)
        
        **Source Code**: [https://github.com/encode/starlette](https://github.com/encode/starlette)
        
        **Online Demo**: [Demo](https://python-sqladmin.herokuapp.com/admin/)
        
        ---
        
        ## Installation
        
        ```shell
        $ pip install sqladmin
        ```
        
        ---
        
        ## Quickstart
        
        Let's define an example SQLAlchemy model:
        
        ```python
        from sqlalchemy import Column, Integer, String, create_engine
        from sqlalchemy.ext.declarative import declarative_base
        
        
        Base = declarative_base()
        engine = create_engine(
            "sqlite:///example.db",
            connect_args={"check_same_thread": False},
        )
        
        
        class User(Base):
            __tablename__ = "users"
        
            id = Column(Integer, primary_key=True)
            name = Column(String)
        
        
        Base.metadata.create_all(engine)  # Create tables
        ```
        
        If you want to use `SQLAdmin` with `FastAPI`:
        
        ```python
        from fastapi import FastAPI
        from sqladmin import Admin, ModelAdmin
        
        
        app = FastAPI()
        admin = Admin(app, engine)
        
        
        class UserAdmin(ModelAdmin, model=User):
            column_list = [User.id, User.name]
        
        
        admin.register_model(UserAdmin)
        ```
        
        Or if you want to use `SQLAdmin` with `Starlette`:
        
        ```python
        from sqladmin import Admin, ModelAdmin
        from starlette.applications import Starlette
        
        
        app = Starlette()
        admin = Admin(app, engine)
        
        
        class UserAdmin(ModelAdmin, model=User):
            column_list = [User.id, User.name]
        
        
        admin.register_model(UserAdmin)
        ```
        
        Now visiting `/admin` on your browser you can see the `SQLAdmin` interface.
        
        ## Related projects and inspirations
        
        * [Flask-Admin](https://github.com/flask-admin/flask-admin) Admin interface for Flask supporting different database backends and ORMs. This project has inspired SQLAdmin extensively and most of the features and configurations are implemented the same.
        * [FastAPI-Admin](https://github.com/fastapi-admin/fastapi-admin) Admin interface for FastAPI which works with `TortoiseORM`.
        * [Dashboard](https://github.com/encode/dashboard) Admin interface for ASGI frameworks which works with the `orm` package.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
