django-litestream 0.0.1__tar.gz

django_litestream-0.0.1/.idea/django-litestream.iml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+    </content>
+    <orderEntry type="jdk" jdkName="Python 3.12 (django-litestream)" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

django_litestream-0.0.1/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,68 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+    <inspection_tool class="HtmlUnknownTag" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="myValues">
+        <value>
+          <list size="20">
+            <item index="0" class="java.lang.String" itemvalue="nobr" />
+            <item index="1" class="java.lang.String" itemvalue="noembed" />
+            <item index="2" class="java.lang.String" itemvalue="comment" />
+            <item index="3" class="java.lang.String" itemvalue="noscript" />
+            <item index="4" class="java.lang.String" itemvalue="embed" />
+            <item index="5" class="java.lang.String" itemvalue="script" />
+            <item index="6" class="java.lang.String" itemvalue="c-button" />
+            <item index="7" class="java.lang.String" itemvalue="c-tabs" />
+            <item index="8" class="java.lang.String" itemvalue="c-tab" />
+            <item index="9" class="java.lang.String" itemvalue="c-accordion" />
+            <item index="10" class="java.lang.String" itemvalue="c-accordion-title" />
+            <item index="11" class="java.lang.String" itemvalue="c-slot" />
+            <item index="12" class="java.lang.String" itemvalue="c-card" />
+            <item index="13" class="java.lang.String" itemvalue="c-theme-toggle" />
+            <item index="14" class="java.lang.String" itemvalue="c-heoricon" />
+            <item index="15" class="java.lang.String" itemvalue="c-heroicon" />
+            <item index="16" class="java.lang.String" itemvalue="c-vars" />
+            <item index="17" class="java.lang.String" itemvalue="c-heroicon-outline" />
+            <item index="18" class="java.lang.String" itemvalue="c-heroicon.micro" />
+            <item index="19" class="java.lang.String" itemvalue="c-heroicon.outline" />
+          </list>
+        </value>
+      </option>
+      <option name="myCustomValuesEnabled" value="true" />
+    </inspection_tool>
+    <inspection_tool class="PyCompatibilityInspection" enabled="true" level="WARNING" enabled_by_default="true">
+      <option name="ourVersions">
+        <value>
+          <list size="3">
+            <item index="0" class="java.lang.String" itemvalue="3.10" />
+            <item index="1" class="java.lang.String" itemvalue="3.11" />
+            <item index="2" class="java.lang.String" itemvalue="3.12" />
+          </list>
+        </value>
+      </option>
+    </inspection_tool>
+    <inspection_tool class="PyPackageRequirementsInspection" enabled="false" level="WARNING" enabled_by_default="false">
+      <option name="ignoredPackages">
+        <value>
+          <list size="13">
+            <item index="0" class="java.lang.String" itemvalue="fuzzy-couscous" />
+            <item index="1" class="java.lang.String" itemvalue="jupyter-core" />
+            <item index="2" class="java.lang.String" itemvalue="notebook-shim" />
+            <item index="3" class="java.lang.String" itemvalue="jupyterlab-server" />
+            <item index="4" class="java.lang.String" itemvalue="typing-extensions" />
+            <item index="5" class="java.lang.String" itemvalue="jupyter-client" />
+            <item index="6" class="java.lang.String" itemvalue="jupyter-server" />
+            <item index="7" class="java.lang.String" itemvalue="jupyterlab-pygments" />
+            <item index="8" class="java.lang.String" itemvalue="jupyter-server-terminals" />
+            <item index="9" class="java.lang.String" itemvalue="jupyterlab-widgets" />
+            <item index="10" class="java.lang.String" itemvalue="dj-notebook" />
+            <item index="11" class="java.lang.String" itemvalue="prometheus-client" />
+            <item index="12" class="java.lang.String" itemvalue="django-tailwind-cli" />
+          </list>
+        </value>
+      </option>
+    </inspection_tool>
+    <inspection_tool class="PyTypeHintsInspection" enabled="true" level="INFORMATION" enabled_by_default="true" />
+  </profile>
+</component>

django_litestream-0.0.1/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

django_litestream-0.0.1/.idea/material_theme_project_new.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MaterialThemeProjectNewConfig">
+    <option name="metadata">
+      <MTProjectMetadataState>
+        <option name="migrated" value="true" />
+        <option name="pristineConfig" value="false" />
+        <option name="userId" value="-19eae3bc:18ab99784c4:-8000" />
+        <option name="version" value="8.13.2" />
+      </MTProjectMetadataState>
+    </option>
+  </component>
+</project>

django_litestream-0.0.1/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Poetry (pw) (2)" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.12 (django-litestream)" project-jdk-type="Python SDK" />
+</project>

django_litestream-0.0.1/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/django-litestream.iml" filepath="$PROJECT_DIR$/.idea/django-litestream.iml" />
+    </modules>
+  </component>
+</project>

django_litestream-0.0.1/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

django_litestream-0.0.1/.idea/workspace.xml

@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="06ad9acc-f715-4fe6-a328-19df77ce9574" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/demo/demo/asgi.py" beforeDir="false" afterPath="$PROJECT_DIR$/demo/demo/asgi.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/demo/demo/settings.py" beforeDir="false" afterPath="$PROJECT_DIR$/demo/demo/settings.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/demo/demo/urls.py" beforeDir="false" afterPath="$PROJECT_DIR$/demo/demo/urls.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/demo/demo/wsgi.py" beforeDir="false" afterPath="$PROJECT_DIR$/demo/demo/wsgi.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/demo/manage.py" beforeDir="false" afterPath="$PROJECT_DIR$/demo/manage.py" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Python Script" />
+      </list>
+    </option>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="GitHubPullRequestSearchHistory"><![CDATA[{
+  "lastFilter": {
+    "state": "OPEN",
+    "assignee": "Tobi-De"
+  }
+}]]></component>
+  <component name="GithubPullRequestsUISettings"><![CDATA[{
+  "selectedUrlAndAccountId": {
+    "url": "git@github.com:Tobi-De/django-litestream.git",
+    "accountId": "d7d9e3ed-0d7c-494d-88b6-c724e1fdfa89"
+  }
+}]]></component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 7
+}</component>
+  <component name="ProjectId" id="2kSdVmzqHeoA51qcKrsajUb6XaN" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+    <option name="showMembers" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "git-widget-placeholder": "main",
+    "last_opened_file_path": "/home/tobi/Builds/django-litestream",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "npm",
+    "vue.rearranger.settings.migration": "true"
+  }
+}]]></component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$" />
+    </key>
+    <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/src/django_litestream" />
+    </key>
+  </component>
+  <component name="SharedIndexes">
+    <attachedChunks>
+      <set>
+        <option value="bundled-js-predefined-1d06a55b98c1-0b3e54e931b4-JavaScript-PY-241.19072.16" />
+        <option value="bundled-python-sdk-8336bb23522e-2767605e8bc2-com.jetbrains.pycharm.pro.sharedIndexes.bundled-PY-241.19072.16" />
+      </set>
+    </attachedChunks>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="06ad9acc-f715-4fe6-a328-19df77ce9574" name="Changes" comment="" />
+      <created>1723280938477</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1723280938477</updated>
+      <workItem from="1723280939699" duration="2190000" />
+      <workItem from="1723284486183" duration="20140000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+</project>

django_litestream-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-symlinks
+      - id: check-json
+
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.13.0
+    hooks:
+      - id: reorder-python-imports
+        args:
+          - "--application-directories=src"
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: "1.20.0"
+    hooks:
+    -   id: django-upgrade
+        args: [--target-version, "5.0"]
+
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: "2.2.1"
+    hooks:
+      - id: pyproject-fmt
+
+  - repo: local
+    hooks:
+      - id: hatch-fmt
+        name: run hatch fmt
+        entry: hatch fmt
+        language: system
+        files: \.py

django_litestream-0.0.1/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Tobi DEGNON <tobidegnon@proton.me>
+
+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.

django_litestream-0.0.1/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.3
+Name: django-litestream
+Version: 0.0.1
+Project-URL: Documentation, https://github.com/Tobi DEGNON/django-litestream#readme
+Project-URL: Issues, https://github.com/Tobi DEGNON/django-litestream/issues
+Project-URL: Source, https://github.com/Tobi DEGNON/django-litestream
+Author-email: Tobi DEGNON <tobidegnon@proton.me>
+License: MIT License
+        
+        Copyright (c) 2024-present Tobi DEGNON <tobidegnon@proton.me>
+        
+        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.
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: django>=4.2
+Requires-Dist: litestream-bin
+Requires-Dist: pyyaml
+Description-Content-Type: text/markdown
+
+# django-litestream
+
+[![PyPI - Version](https://img.shields.io/pypi/v/django-litestream.svg)](https://pypi.org/project/django-litestream)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-litestream.svg)](https://pypi.org/project/django-litestream)
+
+-----
+
+> [!IMPORTANT]
+> This package currently contains minimal features and is a work-in-progress
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install django-litestream
+```
+
+## License
+
+`django-litestream` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

django_litestream-0.0.1/README.md

@@ -0,0 +1,24 @@
+# django-litestream
+
+[![PyPI - Version](https://img.shields.io/pypi/v/django-litestream.svg)](https://pypi.org/project/django-litestream)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-litestream.svg)](https://pypi.org/project/django-litestream)
+
+-----
+
+> [!IMPORTANT]
+> This package currently contains minimal features and is a work-in-progress
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install django-litestream
+```
+
+## License
+
+`django-litestream` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

django_litestream-0.0.1/demo/demo/asgi.py

@@ -0,0 +1,15 @@
+"""
+ASGI config for demo project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
+"""
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
+
+application = get_asgi_application()

django_litestream-0.0.1/demo/demo/settings.py

@@ -0,0 +1,125 @@
+"""
+Django settings for demo project.
+
+Generated by 'django-admin startproject' using Django 4.2.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-1fdgnt7ds_49e#85r6i)b45hhg!-ows-n)cs_*m_^__%88^02c"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "django_litestream",
+]
+
+LITESTREAM = {"config_file": BASE_DIR / "litestream.yml"}
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "demo.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "demo.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.2/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

django_litestream-0.0.1/demo/demo/urls.py

@@ -0,0 +1,22 @@
+"""
+URL configuration for demo project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]

django_litestream-0.0.1/demo/demo/wsgi.py

@@ -0,0 +1,15 @@
+"""
+WSGI config for demo project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/
+"""
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
+
+application = get_wsgi_application()

django_litestream-0.0.1/demo/litestream.yml

@@ -0,0 +1,8 @@
+dbs:
+- path: /home/tobi/Builds/django-litestream/demo/db.sqlite3
+  replicas:
+  - type: s3
+    bucket: $LITESTREAM_REPLICA_BUCKET
+    path: db.sqlite3
+    access-key-id: $LITESTREAM_ACCESS_KEY_ID
+    secret-access-key: $LITESTREAM_SECRET_ACCESS_KEY

django_litestream-0.0.1/demo/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "demo.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

django_litestream-0.0.1/justfile

@@ -0,0 +1,16 @@
+set dotenv-load := true
+
+# List all available commands
+_default:
+    @just --list --unsorted
+
+@fmt:
+    hatch fmt --formatter
+    just --fmt --unstable
+    hatch run pre-commit run reorder-python-imports -a
+
+@dj *ARGS:
+    cd demo && hatch run python manage.py {{ ARGS }}
+
+@run-demo:
+    cd demo && hatch run python manage.py runserver

django_litestream-0.0.1/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "django-litestream"
+dynamic = ["version"]
+description = ''
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE.txt"}
+keywords = []
+authors = [
+  { name = "Tobi DEGNON", email = "tobidegnon@proton.me" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = ["django>=4.2", "litestream-bin", "pyyaml"]
+
+[project.urls]
+Documentation = "https://github.com/Tobi DEGNON/django-litestream#readme"
+Issues = "https://github.com/Tobi DEGNON/django-litestream/issues"
+Source = "https://github.com/Tobi DEGNON/django-litestream"
+
+[tool.hatch.version]
+path = "src/django_litestream/__about__.py"
+
+[tool.hatch.envs.default]
+dependencies = [
+  "pre-commit",
+  "reorder-python-imports",
+]
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/django_litestream tests}"
+
+[tool.coverage.run]
+source_pkgs = ["django_litestream", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/django_litestream/__about__.py",
+]
+
+[tool.coverage.paths]
+django_litestream = ["src/django_litestream", "*/django-litestream/src/django_litestream"]
+tests = ["tests", "*/django-litestream/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

django_litestream-0.0.1/src/django_litestream/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present Tobi DEGNON <tobidegnon@proton.me>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.1"

django_litestream-0.0.1/src/django_litestream/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Tobi DEGNON <tobidegnon@proton.me>
+#
+# SPDX-License-Identifier: MIT

django_litestream-0.0.1/src/django_litestream/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DjangoLitestreamConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_litestream"

django_litestream-0.0.1/src/django_litestream/conf.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+import sys
+from dataclasses import dataclass
+from pathlib import Path
+
+from django.conf import settings
+
+if sys.version_info >= (3, 12):
+    from typing import override as typing_override
+else:  # pragma: no cover
+    from typing_extensions import (
+        override as typing_override,  # pyright: ignore[reportUnreachable]
+    )
+
+override = typing_override
+
+
+DJANGO_LITESTREAM_SETTINGS_NAME = "LITESTREAM"
+
+
+@dataclass(frozen=True)
+class AppSettings:
+    config_file: Path | str = "/etc/litestream.yml"
+    bin_path: Path | str = "litestream"
+    dbs: list[dict[str, str]] = None
+    extra_dbs: list[dict[str, str]] = None
+
+    @override
+    def __getattribute__(self, __name: str) -> object:
+        user_settings = getattr(settings, DJANGO_LITESTREAM_SETTINGS_NAME, {})
+        return user_settings.get(__name, super().__getattribute__(__name))  # pyright: ignore[reportAny]
+
+
+app_settings = AppSettings()

django_litestream-0.0.1/src/django_litestream/management/__init__.py

@@ -0,0 +1,40 @@
+def _get_sqlite_db_path() -> str:
+    """Return the path to the SQLite database file."""
+    from django.conf import settings
+
+    db_settings = settings.DATABASES.get("default")
+    if db_settings and db_settings.get("ENGINE") == "django.db.backends.sqlite3":
+        return db_settings["NAME"]
+    exit("No SQLite database found in settings")
+
+
+def run_setup(_):
+    """Run some project setup tasks"""
+    import os
+    import subprocess
+    from pathlib import Path
+    from django.core.management import execute_from_command_line
+    from django.core.management.base import CommandError
+    from contextlib import suppress
+
+    db_path = _get_sqlite_db_path()
+    # The Litestream configuration uses this environment variable, so it needs
+    # to be injected into every function that runs the Litestream command.
+    os.environ.setdefault("DATABASE_PATH", db_path)
+
+    replica_url = os.getenv("REPLICA_URL")
+
+    if not replica_url:
+        exit("REPLICA_URL environment variable not set")
+
+    if Path(db_path).exists():
+        print("Database already exists, skipping restore")
+    else:
+        print("No database found, restoring from replica if exists")
+        subprocess.run(["litestream", "restore", "-if-replica-exists", "-o", db_path, replica_url])
+
+    execute_from_command_line(["manage", "migrate"])
+    execute_from_command_line(["manage", "setup_periodic_tasks"])
+
+    with suppress(CommandError):
+        execute_from_command_line(["manage", "createsuperuser", "--noinput", "--traceback"])

django_litestream-0.0.1/src/django_litestream/management/commands/litestream.py

@@ -0,0 +1,233 @@
+import subprocess
+import sys
+from argparse import ArgumentParser
+from pathlib import Path
+
+from django.conf import settings
+from django.core.management import BaseCommand
+from yaml import dump
+
+from ...conf import app_settings
+
+CONFIG_ARG = {
+    "name": "-config",
+    "type": Path,
+    "help": f"Path to the litestream configuration file, default: {app_settings.config_file}",
+    "default": app_settings.config_file,
+    "required": False,
+}
+
+DB_PATH_ARG = {
+    "name": "db_path",
+    "type": Path,
+    "help": "Path to the SQLite database file",
+}
+
+DB_PATH_OR_REPLICA_URL_ARG = {
+    "name": "db_path",
+    "help": "Path to the SQLite database file or replica URL",
+}
+
+NO_EXPAND_ENV_ARG = {
+    "name": "-no-expand-env",
+    "action": "store_true",
+    "help": "Disables environment variable expansion in configuration file.",
+    "required": False,
+}
+
+
+def _get_replica_arg(subcommand: str) -> dict:
+    return {
+        "name": "-replica",
+        "help": f"Optional, filters by replica. Only applies when listing database {subcommand}.",
+        "required": False,
+    }
+
+
+litestream_commands = {
+    "databases": {
+        "description": "List databases specified in config file",
+        "arguments": [CONFIG_ARG, NO_EXPAND_ENV_ARG],
+    },
+    "generations": {
+        "description": "List available generations for a database",
+        "arguments": [
+            CONFIG_ARG,
+            NO_EXPAND_ENV_ARG,
+            DB_PATH_OR_REPLICA_URL_ARG,
+            _get_replica_arg("generations"),
+        ],
+    },
+    "replicate": {
+        "description": "Runs a server to replicate databases",
+        "arguments": [
+            CONFIG_ARG,
+            NO_EXPAND_ENV_ARG,
+            {
+                "name": "-exec",
+                "help": "Executes a subcommand. Litestream will exit when the child process exits. "
+                "Useful for simple process management.",
+                "required": False,
+            },
+            # {
+            #     **DB_PATH_ARG,
+            # },
+            # {"name": "replica_url", "help": "URL of the replicas", "action": "append"}
+        ],
+    },
+    "restore": {
+        "description": "Recovers database backup from a replica",
+        "arguments": [
+            DB_PATH_OR_REPLICA_URL_ARG,
+            CONFIG_ARG,
+            NO_EXPAND_ENV_ARG,
+            {
+                "name": "-o",
+                "type": Path,
+                "help": "Output path of the restored database. Defaults to original DB path.",
+                "required": False,
+            },
+            {
+                "name": "-if-replica-exists",
+                "action": "store_true",
+                "help": "Returns exit code of 0 if no backups found.",
+                "required": False,
+            },
+            {
+                "name": "-if-db-not-exists",
+                "action": "store_true",
+                "help": "Returns exit code of 0 if the database already exists.",
+                "required": False,
+            },
+            {
+                "name": "-parallelism",
+                "type": int,
+                "help": "Determines the number of WAL files downloaded in parallel. Defaults to 8",
+                "default": 8,
+                "required": False,
+            },
+            {
+                "name": "-generation",
+                "help": "Restore from a specific generation. Defaults to generation with latest data",
+                "required": False,
+            },
+            {
+                "name": "-index",
+                "type": int,
+                "help": "Restore up to a specific WAL index (inclusive). Defaults to use the highest available index.",
+                "required": False,
+            },
+            {
+                "name": "-timestamp",
+                # "type": datetime,
+                "help": "Restore to a specific point-in-time. Defaults to use the latest available backup.",
+                "required": False,
+            },
+        ],
+    },
+    "snapshots": {
+        "description": "List available snapshots for a database",
+        "arguments": [
+            DB_PATH_OR_REPLICA_URL_ARG,
+            CONFIG_ARG,
+            NO_EXPAND_ENV_ARG,
+            _get_replica_arg("snapshots"),
+        ],
+    },
+    "version": {"description": "Prints the binary version", "arguments": []},
+    "wal": {
+        "description": "List available WAL files for a database",
+        "arguments": [
+            CONFIG_ARG,
+            NO_EXPAND_ENV_ARG,
+            {
+                "name": "-generation",
+                "help": "Optional, filter by a specific generation.",
+                "required": False,
+            },
+            _get_replica_arg("snapshots"),
+        ],
+    },
+}
+
+
+class Command(BaseCommand):
+    help = "Litestream is a tool for replicating SQLite databases."
+
+    def add_arguments(self, parser: ArgumentParser) -> None:
+        subcommands = parser.add_subparsers(help="subcommands", dest="subcommand")
+        init_cmd = subcommands.add_parser(
+            "init",
+            help="Initialize a new Litestream configuration",
+            description="Initialize a new Litestream configuration",
+        )
+
+        _add_argument(init_cmd, CONFIG_ARG)
+
+        for ls_cmd, details in litestream_commands.items():
+            parser = subcommands.add_parser(
+                ls_cmd,
+                help=details["description"],
+                description=details["description"],
+            )
+            for args in details["arguments"]:
+                _add_argument(parser, args)
+
+    def handle(self, *args, **options) -> None:
+        if options["subcommand"] == "init":
+            _init(filepath=options["config"])
+            self.stdout.write(self.style.SUCCESS("Litestream configuration file created"))
+        elif len(sys.argv) == 2:
+            self.print_help("manage", "litestream")
+        else:
+            ls_args = sys.argv[2:]
+            if "db_path" in options:
+                # if database alias specified, replace it by the file location
+                original_value = options["db_path"]
+                db_path = _db_location_from_alias(original_value)
+                index_original_value = ls_args.index(original_value)
+                ls_args[index_original_value] = db_path
+            if "-config" not in ls_args and options["subcommand"] != "version":
+                ls_args.extend(["-config", str(options["config"])])
+            # print(ls_args)
+            subprocess.run([app_settings.bin_path, *ls_args])
+
+
+def _db_location_from_alias(alias: str) -> str:
+    db_settings = settings.DATABASES.get(alias, {})
+    if db_settings.get("ENGINE") == "django.db.backends.sqlite3":
+        return db_settings["NAME"]
+    return alias
+
+
+def _init(filepath: Path):
+    if app_settings.dbs:
+        dbs = app_settings.dbs
+    else:
+        dbs = []
+        for db_settings in settings.DATABASES.values():
+            if db_settings["ENGINE"] == "django.db.backends.sqlite3":
+                location = str(db_settings["NAME"])
+                dbs.append(
+                    {
+                        "path": location,
+                        "replicas": [
+                            {
+                                "type": "s3",
+                                "bucket": "$LITESTREAM_REPLICA_BUCKET",
+                                "path": Path(location).name,
+                                "access-key-id": "$LITESTREAM_ACCESS_KEY_ID",
+                                "secret-access-key": "$LITESTREAM_SECRET_ACCESS_KEY",
+                            }
+                        ],
+                    }
+                )
+        if app_settings.extra_dbs:
+            dbs.extend(app_settings.extra_dbs)
+    with open(filepath, "w") as f:
+        dump({"dbs": dbs}, f, sort_keys=False)
+
+
+def _add_argument(parser: ArgumentParser, args: dict) -> None:
+    copied_args = args.copy()
+    parser.add_argument(copied_args.pop("name"), **copied_args)

django_litestream-0.0.1/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Tobi DEGNON <tobidegnon@proton.me>
+#
+# SPDX-License-Identifier: MIT