initial commit

Co-authored-by: pbrochar <[email protected]>
Co-authored-by: mde-pach <[email protected]>

.env.template

@@ -0,0 +1,4 @@
+BLITZ_PORT=8100
+DEFAULT_FILE="blitz.json"
+BLITZ_DB_TYPE="MEMORY"
+BLITZ_OPENAI_API_KEY=""

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: documentation 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+      - run: poetry install --with=doc 
+      - run: poetry run mkdocs gh-deploy --force

.gitignore

@@ -0,0 +1,168 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+app.db
+database.db
+
+*migration.py
+.python-version
+.DS_Store
+.nicegui/

LICENSE.txt

@@ -0,0 +1 @@
+MIT

README.md

@@ -0,0 +1,76 @@
+#
+
+![alt text](./docs/images/blitz_banner.png)
+<p align="center">
+  <em>⚡️ Lightspeed API builder ⚡️</em>
+</p>
+
+![app version](https://img.shields.io/badge/version-0.1.0-brightgreen)
+![app license](https://img.shields.io/badge/license-MIT-brightgreen)
+
+> [!CAUTION]
+> Do not use in production, this is an alpha version.
+
+Full [Documentation](https://paperz-org.github.io/blitz/) here.
+
+# **What is Blitz ?**
+Blitz is a tool that build restfull API on the fly based on a simple and easy to maintain configuration file.
+
+Here is an example of how simple a Blitz file is:
+  ```yaml
+  config:
+    name: Hello world
+    description: Here is a simple blitz configuration file.
+    version: 0.1.0
+  models:
+  - name: TodoList
+    fields:
+      name: str
+      description: str
+  - name: Todo
+    fields:
+      name: str
+      due_date: str
+      todo_list_id: TodoList.id
+  ```
+> [!NOTE]
+> Also available in Json format.
+
+# Quickstart
+
+## Installation
+
+### Using [pipx](https://pipx.pypa.io/stable/installation/) (recommanded)
+```bash
+pipx install git+https://github.com/Paperz-org/[email protected]
+```
+
+## Create a blitz app
+
+```console
+blitz create your-blitz-app
+```
+
+## Start your blitz app
+
+```console
+blitz start your-blitz-app
+```
+
+*And yeah, that's it.*
+
+Just add some resources in the blitz file, and you have now a fully functional API with models and the corresponding database schema with all the modern feature you can expect from a modern app like:
+
+- Automatic Swagger UI for the API
+- Admin
+- Dashboard
+- Data validation and error messages (thanks to Fastapi and SQLModel)
+- Automatic database migration based on the changes of your blitz file
+- Generated ERD diagram
+- and more...
+
+<p align="center">
+  <em>Made with :heart: and :coffee: by <a href="https://github.com/mde-pach">mde-pach</a> and <a href="https://github.com/pbrochar">pbrochar</a></em>
+</p>
+
+

blitz/__init__.py

@@ -0,0 +1,5 @@
+from .core import BlitzCore
+
+__all__ = [
+    "BlitzCore",
+]

blitz/alembic/README

@@ -0,0 +1 @@
+Generic single-database configuration.

blitz/alembic/env.py

@@ -0,0 +1,81 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+from blitz.models import BaseResourceModel
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = BaseResourceModel.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    connectable = config.attributes.get("connection", None)
+
+    if connectable is None:
+        # only create Engine if we don't have a Connection
+        # from the outside
+        connectable = engine_from_config(
+            config.get_section(config.config_ini_section, {}),
+            prefix="sqlalchemy.",
+            poolclass=pool.NullPool,
+        )
+
+        with connectable.connect() as connection:
+            context.configure(connection=connection, target_metadata=target_metadata)
+
+            with context.begin_transaction():
+                context.run_migrations()
+    else:
+        context.configure(connection=connectable, target_metadata=target_metadata)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()