dotstash 0.1.0__tar.gz

dotstash-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,73 @@
+name: CI and Publish
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  checks:
+    name: Lint, Type, Test, Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --locked --group dev
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Pyright
+        run: uv run pyright
+
+      - name: Pytest
+        run: uv run pytest
+
+      - name: Build
+        run: uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: checks
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      id-token: write
+      contents: read
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dotstash
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

dotstash-0.1.0/.gitignore

@@ -0,0 +1,177 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# 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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+.envrc

dotstash-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

dotstash-0.1.0/AGENTS.md

@@ -0,0 +1,128 @@
+# Repository Guidelines (stash)
+
+## Purpose
+- This file guides agentic coding assistants working in this repo.
+- Follow local patterns, keep changes minimal, and prefer explicit errors.
+
+## Project Structure & Module Organization
+- `stash/` holds application logic.
+  - `stash/main.py`: CLI entry, config loading, orchestration.
+  - `stash/render.py`: Jinja rendering + symlink wiring.
+  - `stash/formats.py`: format validation helpers.
+  - `stash/database.py`: Pydantic model stubs.
+- `test/` contains pytest suites.
+  - `test/assets/` holds fixture templates and config inputs.
+- `config.yaml` in repo root is sample config, not production.
+
+## Environment & Dependencies
+- Python version: `>=3.14` (see `.python-version`).
+- Install dev deps (choose one):
+  - `pip install -e .[dev]`
+  - `uv sync`
+- Script entrypoint: `stash` → `stash.main:main` (see `pyproject.toml`).
+
+## Build, Lint, Type Check, Test
+### Build
+- Build distributions:
+  - `python -m build`
+
+### Lint + Format (Ruff)
+- Lint:
+  - `ruff check .`
+  - `ruff check --fix .` (apply auto-fixes)
+- Format:
+  - `ruff format .`
+  - `ruff format --check .`
+  - `ruff format --diff .`
+
+### Type Checking
+- `pyright`
+
+### Tests (Pytest)
+- Run all tests:
+  - `pytest`
+- Run a single file:
+  - `pytest test/test_render.py`
+  - `pytest test/test_formats.py`
+- Run a single test:
+  - `pytest test/test_render.py::test_render`
+  - `pytest test/test_formats.py::test_json_validator`
+- Run by name pattern:
+  - `pytest -k "render"`
+  - `pytest -k "json"`
+- Re-run failed tests:
+  - `pytest --lf`
+  - `pytest --ff`
+- Stop on first failure:
+  - `pytest -x`
+- Verbose output:
+  - `pytest -v`
+  - `pytest -vv`
+
+## Coding Style & Conventions
+### Imports
+- Standard library first, third-party second, local imports last.
+- Prefer explicit imports over `import *`.
+
+### Formatting
+- 4-space indentation, no tabs.
+- Keep lines readable; let `ruff format` enforce formatting.
+- Avoid trailing whitespace and extra blank lines.
+
+### Types
+- Use type hints where practical (see `render.py`).
+- Prefer concrete types (`dict[str, Any]`) over `dict`.
+- Avoid type suppression (`as any`, `# type: ignore`).
+
+### Naming
+- Files: snake_case.
+- Functions and variables: snake_case.
+- Classes: PascalCase.
+- Avoid one-letter variables unless in tiny local scopes.
+
+### Path Handling
+- Prefer `pathlib.Path` for filesystem operations.
+- Use `Path.open()` and `Path.write_text()`.
+
+### Error Handling
+- Raise explicit errors for invalid config or invalid states.
+- Do not swallow exceptions silently.
+- Prefer explicit messaging for user-facing CLI errors.
+
+### Logging/Output
+- Current code uses `print()` for CLI output. Follow that pattern.
+- If adding logging, keep it minimal and consistent.
+
+## Template & Rendering Behavior
+- Jinja environment uses `StrictUndefined` to surface missing variables.
+- Rendered templates are written under render root and symlinked to targets.
+- Avoid clobbering real directories; raise if target is a directory.
+
+## Tests & Fixtures
+- Tests live in `test/` and are named `test_*.py`.
+- Fixture assets live in `test/assets/`.
+- For new template features:
+  - Add sample templates under `test/assets/dotfiles/<module>/`.
+  - Assert renders exist under render root.
+  - Confirm targets are symlinks pointing to rendered files.
+
+## Configuration & Safety
+- Do not commit real secrets into fixtures or `config.yaml`.
+- Avoid writing to real home directories in tests.
+- Use `tmp_path` for filesystem fixtures in pytest.
+
+## Repo-Specific Notes
+- `pyproject.toml` is the single source of tool configuration.
+- No `tox.ini`, `noxfile`, or `pytest.ini` present.
+- No Cursor rules (`.cursor/rules/`, `.cursorrules`) found.
+- No Copilot rules (`.github/copilot-instructions.md`) found.
+
+## Change Management
+- Keep changes minimal and scoped to the request.
+- Avoid refactors when fixing a specific bug.
+- Update tests when behavior changes.
+
+## Validation Checklist
+- Run relevant unit tests for touched modules.
+- Run `ruff check .` and `ruff format .` after code changes.
+- Run `pyright` if type-sensitive changes were made.

dotstash-0.1.0/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright 2026 Frede Hoey
+
+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.
+

dotstash-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: dotstash
+Version: 0.1.0
+Summary: A dotfile manager with template support
+License-File: LICENSE.txt
+Requires-Python: >=3.14
+Requires-Dist: alembic>=1.18.1
+Requires-Dist: inotify>=0.2.12
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pytoml>=0.1.21
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: questionary>=2.1.0
+Requires-Dist: rich>=13.9.4
+Requires-Dist: sqlalchemy>=2.0.45

dotstash-0.1.0/migrations/env.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+from stash.models import Base
+
+config = context.config
+
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+target_metadata = Base.metadata
+
+
+def _get_sqlalchemy_url() -> str:
+    url = config.get_main_option("sqlalchemy.url")
+    if not url:
+        raise RuntimeError("sqlalchemy.url is not configured for migrations")
+    return url
+
+
+def run_migrations_offline() -> None:
+    url = _get_sqlalchemy_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        render_as_batch=True,
+        compare_type=True,
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    configuration = config.get_section(config.config_ini_section) or {}
+    configuration["sqlalchemy.url"] = _get_sqlalchemy_url()
+
+    connectable = engine_from_config(
+        configuration,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            render_as_batch=True,
+            compare_type=True,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

dotstash-0.1.0/migrations/script.py.mako

@@ -0,0 +1,23 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

dotstash-0.1.0/migrations/versions/001_initial_schema.py

@@ -0,0 +1,87 @@
+from alembic import op
+import sqlalchemy as sa
+
+revision = "001_initial_schema"
+
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    op.create_table(
+        "generations",
+        sa.Column("id", sa.Uuid(), nullable=False),
+        sa.Column(
+            "created_at",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("CURRENT_TIMESTAMP"),
+            nullable=False,
+        ),
+        sa.Column("description", sa.Text(), nullable=True),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(op.f("ix_generations_created_at"), "generations", ["created_at"])
+    op.create_table(
+        "dotfile_modules",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("generation_id", sa.Uuid(), nullable=False),
+        sa.Column("module_name", sa.String(length=255), nullable=False),
+        sa.Column("output_path", sa.Text(), nullable=False),
+        sa.Column("target_path", sa.Text(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["generation_id"],
+            ["generations.id"],
+            ondelete="CASCADE",
+        ),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint(
+            "generation_id", "module_name", name="uq_generation_module"
+        ),
+    )
+    op.create_index(
+        op.f("ix_dotfile_modules_generation_id"),
+        "dotfile_modules",
+        ["generation_id"],
+    )
+    op.create_index(
+        op.f("ix_dotfile_modules_module_name"),
+        "dotfile_modules",
+        ["module_name"],
+    )
+    op.create_table(
+        "rendered_files",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("module_id", sa.Integer(), nullable=False),
+        sa.Column("file_path", sa.Text(), nullable=False),
+        sa.Column("template_path", sa.Text(), nullable=False),
+        sa.Column("content_hash", sa.String(length=64), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["module_id"], ["dotfile_modules.id"], ondelete="CASCADE"
+        ),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("module_id", "file_path", name="uq_module_file"),
+    )
+    op.create_index(
+        op.f("ix_rendered_files_content_hash"),
+        "rendered_files",
+        ["content_hash"],
+    )
+    op.create_index(
+        op.f("ix_rendered_files_module_id"),
+        "rendered_files",
+        ["module_id"],
+    )
+
+
+def downgrade() -> None:
+    op.drop_index(op.f("ix_rendered_files_module_id"), table_name="rendered_files")
+    op.drop_index(op.f("ix_rendered_files_content_hash"), table_name="rendered_files")
+    op.drop_table("rendered_files")
+    op.drop_index(op.f("ix_dotfile_modules_module_name"), table_name="dotfile_modules")
+    op.drop_index(
+        op.f("ix_dotfile_modules_generation_id"), table_name="dotfile_modules"
+    )
+    op.drop_table("dotfile_modules")
+    op.drop_index(op.f("ix_generations_created_at"), table_name="generations")
+    op.drop_table("generations")

dotstash-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "dotstash"
+version = "0.1.0"
+description = "A dotfile manager with template support"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "alembic>=1.18.1",
+    "inotify>=0.2.12",
+    "jinja2>=3.1.6",
+    "pydantic>=2.12.5",
+    "pytoml>=0.1.21",
+    "pyyaml>=6.0.3",
+    "questionary>=2.1.0",
+    "rich>=13.9.4",
+    "sqlalchemy>=2.0.45",
+]
+
+[project.scripts]
+stash = "stash.main:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = [
+    "stash",
+    "migrations",
+]
+
+[dependency-groups]
+dev = [
+    "debugpy>=1.8.19",
+    "pyright>=1.1.408",
+    "pytest>=9.0.2",
+    "ruff>=0.14.10",
+    "ty>=0.0.8",
+    "zuban>=0.4.1",
+]
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "stash"
+]