jetbase 0.12.2__tar.gz

jetbase-0.12.2/.github/workflows/ci.yml

@@ -0,0 +1,236 @@
+name: CI
+
+on:
+  pull_request:
+    paths:
+      - "jetbase/**" # only run when code inside my_package changes
+      - ".github/workflows/ci-pr.yml" # rerun if this workflow changes
+      - "pyproject.toml" # rerun if deps/config change
+      - "uv.lock" # rerun if lockfile changes
+  workflow_dispatch: {}
+jobs:
+  lint-type-format-checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Pyrefly type checker
+        run: uv run pyrefly check
+
+      - name: Ruff linter
+        run: uv run ruff check jetbase tests
+
+      - name: Ruff formatter
+        run: uv run ruff format jetbase tests --check
+
+  unit-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run unit tests
+        run: uv run pytest tests/unit/ -v
+
+  postgres-cli-tests:
+    runs-on: ubuntu-latest
+
+    env:
+      JETBASE_SQLALCHEMY_URL: postgresql://postgres:postgres@localhost:5432/test_db
+
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test_db
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run CLI tests
+        run: uv run pytest tests/cli/ -v
+
+  sqlite-cli-tests:
+    runs-on: ubuntu-latest
+
+    env:
+      JETBASE_SQLALCHEMY_URL: sqlite:///test.db
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run CLI tests
+        run: uv run pytest tests/cli/ -v
+
+  integration-tests:
+    runs-on: ubuntu-latest
+
+    env:
+      JETBASE_SQLALCHEMY_URL: postgresql://postgres:postgres@localhost:5432/test_db
+
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test_db
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run jetbase rollback with no migrations table created
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase rollback
+
+      - name: Run jetbase current with no migrations table created
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase current
+
+      - name: Run jetbase history with no migrations table created
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase history
+
+      - name: Run jetbase upgrade with --dry-run param
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase upgrade --dry-run
+
+      - name: Run upgrade dry-run test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "dry_run" test_upgrade.py
+
+      - name: Run jetbase upgrade with --count param
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase upgrade --count 2
+
+      - name: Run upgrade count test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "count" test_upgrade.py
+
+      - name: Run jetbase upgrade with --to-version param
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase upgrade --to-version 5
+
+      - name: Run upgrade to-version test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "to_version" test_upgrade.py
+
+      - name: Run jetbase upgrade
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase upgrade
+
+      - name: Run upgrade basic test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "basic" test_upgrade.py
+
+      - name: Run jetbase rollback with --dry-run param
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase rollback --dry-run
+
+      - name: Run rollback dry-run test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "dry_run" test_rollback.py
+
+      - name: Run jetbase rollback with --count param
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase rollback -c 2
+
+      - name: Run rollback count test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "count" test_rollback.py
+
+      - name: Run jetbase rollback
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase rollback
+
+      - name: Run rollback basic test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "basic" test_rollback.py
+
+      - name: Run jetbase rollback with --to param
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase rollback --to-version 2
+
+      - name: Run rollback to_version integration test
+        working-directory: tests/test_integration
+        run: uv run pytest -m "to_version" test_rollback.py
+
+      - name: Run jetbase current
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase current
+
+      - name: Run jetbase history
+        working-directory: tests/test_integration/jetbase
+        run: uv run jetbase history

jetbase-0.12.2/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    if: github.actor == 'jaz-alli' && startsWith(github.ref, 'refs/tags/')
+
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Build package
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: true

jetbase-0.12.2/.github/workflows/publish_docs.yml

@@ -0,0 +1,27 @@
+name: Deploy Docs
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+    if: github.actor == 'jaz-alli'
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      
+      - name: Install dependencies
+        run: |
+          pip install mkdocs-material
+      
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force
+

jetbase-0.12.2/.gitignore

@@ -0,0 +1,177 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Other files and folders
+.python-version

jetbase-0.12.2/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.1
+    hooks:
+      - id: ruff-check
+        args: ["I", "--fix"]
+      - id: ruff-format
+
+  - repo: https://github.com/facebook/pyrefly-pre-commit
+    rev: 0.0.1
+    hooks:
+      - id: pyrefly-typecheck-system
+        name: Pyrefly
+        pass_filenames: false

jetbase-0.12.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 jaz-alli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

jetbase-0.12.2/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: jetbase
+Version: 0.12.2
+Summary: Jetbase is a Python database migration tool
+Author-email: jaz <jaz.allibhai@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: packaging>=25.0
+Requires-Dist: rich>=12.2.0
+Requires-Dist: sqlalchemy>=2.0.10
+Requires-Dist: tomli>=2.0.2
+Requires-Dist: typer>=0.12.3
+Description-Content-Type: text/markdown
+
+# Welcome to Jetbase 🚀
+
+**Jetbase** is a simple, lightweight database migration tool for Python projects.
+
+Jetbase helps you manage database migrations in a simple, version-controlled way. Whether you're adding a new table, modifying columns, or need to undo a change, Jetbase makes it super easy!
+
+### Key Features ✨
+
+- **📦 Simple Setup** — Get started with just one command
+- **⬆️ Easy Upgrades** — Apply pending migrations with confidence
+- **⬇️ Safe Rollbacks** — Made a mistake? No problem, roll it back!
+- **📊 Clear Status** — Always know which migrations have been applied and which are pending
+- **🔒 Migration Locking** — Prevents conflicts when multiple processes try to migrate
+- **✅ Checksum Validation** — Detects if migration files have been modified
+- **🔄 Repeatable Migrations** — Support for migrations that run on every upgrade
+
+[📚 Full Documentation](https://jetbase-hq.github.io/jetbase/)
+
+## Quick Start 🏃‍♂️
+
+### Installation
+
+**Using pip:**
+```shell
+pip install jetbase
+```
+
+**Using uv:**
+```shell
+uv add jetbase
+```
+
+### Initialize Your Project
+
+```bash
+jetbase init
+cd jetbase
+```
+
+This creates a `jetbase/` directory with:
+
+- A `migrations/` folder for your SQL files
+- An `env.py` configuration file
+
+### Configure Your Database
+
+Edit `jetbase/env.py` with your database connection string (currently support for postgres and sqlite):
+
+**PostgreSQL example:**
+```python
+sqlalchemy_url = "postgresql+psycopg2://user:password@localhost:5432/mydb"
+```
+
+**SQLite example:**
+```python
+sqlalchemy_url = "sqlite:///mydb.db"
+```
+
+### Create Your First Migration
+
+```bash
+jetbase new "create users table"
+```
+
+This creates a new SQL file like `V20251225.120000__create_users_and_items_tables.sql`.
+
+> **Tip:**  
+> You can also create migrations manually by adding SQL files in the `jetbase/migrations` directory, using the `V<version>__<description>.sql` naming convention (e.g., `V1__add_users_table.sql`, `V2.4__add_users_table.sql`).
+
+
+### Write Your Migration
+
+Open the newly created file and add your SQL:
+
+```sql
+-- upgrade
+CREATE TABLE users (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(100) NOT NULL,
+    email VARCHAR(255) UNIQUE NOT NULL
+);
+
+CREATE TABLE items (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(100) NOT NULL
+);
+
+-- rollback
+DROP TABLE items;
+DROP TABLE users;
+```
+
+### Apply the Migration
+
+```bash
+jetbase upgrade
+```
+
+That's it! Your database is now up to date. 🎉
+
+> **Note:**  
+> Jetbase uses SQLAlchemy under the hood to manage database connections.  
+> For any database other than SQLite, you must install the appropriate Python database driver.  
+> For example, to use Jetbase with PostgreSQL:
+
+```bash
+pip install psycopg2
+```
+
+You can also use another compatible driver if you prefer (such as `asyncpg`, `pg8000`, etc.).
+
+## Supported Databases
+
+Jetbase currently supports:
+
+- ✅ PostgreSQL
+- ✅ SQLite
+
+## Need Help?
+
+Open an issue on GitHub!