filemindr 0.1.0__tar.gz

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

@@ -0,0 +1,46 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/astral-sh/uv:python3.12-bookworm
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Create venv
+        run: uv venv
+
+      - name: Install project + dev deps
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest -q
+
+  publish:
+    name: Build & Publish (PyPI)
+    needs: test
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/astral-sh/uv:python3.12-bookworm
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --token ${{ secrets.PYPI_API_TOKEN }}

filemindr-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+.idea
+__pycache__
+.venv
+fileflow.yaml

filemindr-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-toml
+      - id: check-yaml
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        args: ["-L", "nd,teh"]

filemindr-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

filemindr-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: filemindr
+Version: 0.1.0
+Summary: Declarative local file pipelines in Python
+Author: Jeferson Peter
+Requires-Python: >=3.12
+Requires-Dist: loguru
+Requires-Dist: pydantic-settings
+Requires-Dist: pyyaml
+Requires-Dist: typer
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Filemindr — Rule-Driven Local File Automation
+
+**Declarative local file pipelines for organizing your files.**
+
+filemindr lets you describe *what should happen* to your files — not *how*.  
+You define rules in YAML (extensions, regex, age, priority), and filemindr applies them safely with dry‑run support, conflict handling, and a clean CLI.
+
+This project was built as a learning + portfolio tool focused on clarity, safety, and developer experience.
+
+---
+
+## ✨ Features
+
+- Declarative YAML configuration
+- Rule engine with priority (highest wins)
+- Match by:
+  - File extensions
+  - Regex on filename
+  - File age (`older_than_days`)
+- Conflict policies:
+  - `rename`
+  - `skip`
+  - `overwrite`
+- Dry-run mode (preview changes before touching files)
+- Summary report after each run
+- Proper logging levels (`INFO` / `DEBUG`)
+- Cross-platform (Windows, macOS, Linux)
+
+---
+
+## 📦 Installation
+
+### From PyPI (planned / when published)
+
+```bash
+pip install Filemindr
+```
+
+Or:
+
+```bash
+python -m pip install Filemindr
+```
+
+### Local development
+
+```bash
+pip install -e .
+```
+
+With uv:
+
+```bash
+uv sync
+```
+
+---
+
+## 🚀 Quick Start
+
+Create a `filemindr.yaml`:
+
+```yaml
+source: ~/Downloads
+default_target: ~/Downloads/others
+conflict_policy: rename
+
+rules:
+  - name: invoices
+    priority: 100
+    match:
+      extensions: ["pdf"]
+      regex: "(?i)invoice|nota|nf"
+    action:
+      move_to: ~/Downloads/finance/invoices
+
+  - name: documents
+    priority: 50
+    match:
+      extensions: ["pdf", "docx", "xlsx"]
+    action:
+      move_to: ~/Downloads/documents
+
+  - name: images
+    priority: 40
+    match:
+      extensions: ["jpg", "jpeg", "png", "webp"]
+    action:
+      move_to: ~/Downloads/images
+
+  - name: old_installers
+    priority: 80
+    match:
+      extensions: ["exe", "msi"]
+      older_than_days: 14
+    action:
+      move_to: ~/Downloads/installers/old
+```
+
+Preview changes:
+
+```bash
+filemindr run --dry-run
+```
+
+Run for real:
+
+```bash
+filemindr run
+```
+
+Verbose mode (per-file logs):
+
+```bash
+filemindr run --log-level DEBUG
+```
+
+---
+
+## 🧠 How it works
+
+1. Filemind scans the source directory
+2. Rules are evaluated by priority (highest first)
+3. The first matching rule wins
+4. Files are moved according to the selected conflict policy
+5. A summary is printed at the end
+
+---
+
+## ⚔ Conflict Policy
+
+- `rename` (default): creates `file (1).ext`, `file (2).ext`, etc
+- `skip`: ignores files that already exist
+- `overwrite`: replaces existing files
+
+---
+
+## 🧪 Development
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+Project layout:
+
+```
+filemindr/
+├── src/filemindr/
+├── tests/
+├── pyproject.toml
+└── README.md
+```
+
+---
+
+## 🛠 Status
+
+Early alpha / experimental.
+
+APIs may change.
+
+---
+
+## 📄 License
+
+MIT
+
+---
+
+## Roadmap
+
+- [ ] Watch mode (real-time folder monitoring)
+- [ ] Per-rule conflict policies
+- [ ] Copy instead of move
+- [ ] Trash support
+- [ ] Config validation

filemindr-0.1.0/README.md

@@ -0,0 +1,178 @@
+# Filemindr — Rule-Driven Local File Automation
+
+**Declarative local file pipelines for organizing your files.**
+
+filemindr lets you describe *what should happen* to your files — not *how*.  
+You define rules in YAML (extensions, regex, age, priority), and filemindr applies them safely with dry‑run support, conflict handling, and a clean CLI.
+
+This project was built as a learning + portfolio tool focused on clarity, safety, and developer experience.
+
+---
+
+## ✨ Features
+
+- Declarative YAML configuration
+- Rule engine with priority (highest wins)
+- Match by:
+  - File extensions
+  - Regex on filename
+  - File age (`older_than_days`)
+- Conflict policies:
+  - `rename`
+  - `skip`
+  - `overwrite`
+- Dry-run mode (preview changes before touching files)
+- Summary report after each run
+- Proper logging levels (`INFO` / `DEBUG`)
+- Cross-platform (Windows, macOS, Linux)
+
+---
+
+## 📦 Installation
+
+### From PyPI (planned / when published)
+
+```bash
+pip install Filemindr
+```
+
+Or:
+
+```bash
+python -m pip install Filemindr
+```
+
+### Local development
+
+```bash
+pip install -e .
+```
+
+With uv:
+
+```bash
+uv sync
+```
+
+---
+
+## 🚀 Quick Start
+
+Create a `filemindr.yaml`:
+
+```yaml
+source: ~/Downloads
+default_target: ~/Downloads/others
+conflict_policy: rename
+
+rules:
+  - name: invoices
+    priority: 100
+    match:
+      extensions: ["pdf"]
+      regex: "(?i)invoice|nota|nf"
+    action:
+      move_to: ~/Downloads/finance/invoices
+
+  - name: documents
+    priority: 50
+    match:
+      extensions: ["pdf", "docx", "xlsx"]
+    action:
+      move_to: ~/Downloads/documents
+
+  - name: images
+    priority: 40
+    match:
+      extensions: ["jpg", "jpeg", "png", "webp"]
+    action:
+      move_to: ~/Downloads/images
+
+  - name: old_installers
+    priority: 80
+    match:
+      extensions: ["exe", "msi"]
+      older_than_days: 14
+    action:
+      move_to: ~/Downloads/installers/old
+```
+
+Preview changes:
+
+```bash
+filemindr run --dry-run
+```
+
+Run for real:
+
+```bash
+filemindr run
+```
+
+Verbose mode (per-file logs):
+
+```bash
+filemindr run --log-level DEBUG
+```
+
+---
+
+## 🧠 How it works
+
+1. Filemind scans the source directory
+2. Rules are evaluated by priority (highest first)
+3. The first matching rule wins
+4. Files are moved according to the selected conflict policy
+5. A summary is printed at the end
+
+---
+
+## ⚔ Conflict Policy
+
+- `rename` (default): creates `file (1).ext`, `file (2).ext`, etc
+- `skip`: ignores files that already exist
+- `overwrite`: replaces existing files
+
+---
+
+## 🧪 Development
+
+Run tests:
+
+```bash
+uv run pytest
+```
+
+Project layout:
+
+```
+filemindr/
+├── src/filemindr/
+├── tests/
+├── pyproject.toml
+└── README.md
+```
+
+---
+
+## 🛠 Status
+
+Early alpha / experimental.
+
+APIs may change.
+
+---
+
+## 📄 License
+
+MIT
+
+---
+
+## Roadmap
+
+- [ ] Watch mode (real-time folder monitoring)
+- [ ] Per-rule conflict policies
+- [ ] Copy instead of move
+- [ ] Trash support
+- [ ] Config validation

filemindr-0.1.0/main.py

@@ -0,0 +1,6 @@
+def main():
+    print("Hello from filemindr!")
+
+
+if __name__ == "__main__":
+    main()

filemindr-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "filemindr"
+version = "0.1.0"
+description = "Declarative local file pipelines in Python"
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "Jeferson Peter" }]
+
+dependencies = [
+  "typer",
+  "pyyaml",
+  "loguru",
+  "pydantic-settings",
+]
+
+[project.scripts]
+filemindr = "filemindr.cli:app"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8",
+  "ruff>=0.5",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

filemindr-0.1.0/src/filemindr/cli.py

@@ -0,0 +1,32 @@
+import sys
+import typer
+from loguru import logger
+
+from filemindr.core.config import resolve_config
+from filemindr.core.runner import run_pipeline
+
+app = typer.Typer(help="Declarative local file pipelines")
+
+
+@app.command()
+def run(
+    config: str = "filemindr.yaml",
+    dry_run: bool = False,
+    log_level: str = typer.Option("INFO", help="Log level: INFO or DEBUG"),
+):
+    """
+    Run filemindr pipeline.
+    """
+    # Configura logging
+    logger.remove()
+    logger.add(sys.stdout, level=log_level.upper())
+
+    config_path = resolve_config(config)
+
+    logger.info(f"Running pipeline with config={config_path} dry_run={dry_run}")
+
+    run_pipeline(str(config_path), dry_run)
+
+
+if __name__ == "__main__":
+    app()

filemindr-0.1.0/src/filemindr/core/config.py

@@ -0,0 +1,16 @@
+from pathlib import Path
+
+
+def resolve_config(cli_path: str | None = None) -> Path:
+    if cli_path:
+        return Path(cli_path).expanduser()
+
+    local = Path.cwd() / "filemindr.yaml"
+    if local.exists():
+        return local
+
+    home = Path.home() / ".filemindr" / "config.yaml"
+    if home.exists():
+        return home
+
+    raise FileNotFoundError("No filemindr config found.")