refactor-cli 0.1.0__tar.gz → 0.2.0__tar.gz

refactor_cli-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

refactor_cli-0.2.0/.gitignore

@@ -0,0 +1,211 @@
+notes.md
+testing-dir
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.venv
+.venv-pypi
+
+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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

refactor_cli-0.2.0/.refactorignore

@@ -0,0 +1 @@
+*.txt

refactor_cli-0.2.0/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: refactor-cli
+Version: 0.2.0
+Summary: CLI tool to organize files using AI
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: requests
+Requires-Dist: python-dotenv
+Dynamic: license-file
+
+# refactor.ai
+
+`refactor.ai` is a Python CLI for inspecting local directories before automating file organization. The package is published as [`refactor-cli`](https://pypi.org/project/refactor-cli/) and targets Python 3.8+.
+
+## Current scope
+
+The CLI entry point in [refactor/cli.py](refactor/cli.py) provides:
+
+- `version` — prints the installed package version.
+- `tree` — prints a recursive directory tree through [refactor/tree.py](refactor/tree.py).
+- `scan` — collects basic file and directory metadata through [refactor/scanner.py](refactor/scanner.py) and [refactor/metadata.py](refactor/metadata.py).
+- `setup` — configures a multimodal backend (`hosted` or `local`), persisted to `~/.refactor/config.json`.
+- `get-image-context` — obtains Imagga V3 tags/captions, asks Gemini to choose a
+  destination category, and writes JSON context.
+- `refactor-images` — automatically refreshes image context, then moves images
+  into Gemini-selected existing or new category folders (`--copy` is available
+  when the originals must be retained).
+- Path checks through [refactor/validation.py](refactor/validation.py), including existence, directory type, and read access.
+- Optional filename exclusions through [refactor/ignore.py](refactor/ignore.py).
+
+On first CLI run, users are prompted to run setup. They can rerun setup anytime with `refactor setup` or edit `~/.refactor/config.json` directly.
+
+## Setup workflow
+
+After installing `refactor-cli`, the first CLI run prompts:
+
+1. **Hosted model (bring your own API keys)**  
+   - Prompts for `IMAGGA_API_KEY`, `IMAGGA_API_SECRET`, and `GEMINI_API_KEY`  
+   - Saves credentials to `~/.refactor/.env` with restricted file permissions
+2. **Local multimodal recommendation (stub)**  
+   - Detects basic hardware (CPU, memory, NVIDIA GPU/VRAM if available)  
+   - Recommends an OSS multimodal model and records it in config  
+   - Uses a local shim stub today (full local runtime integration is a follow-up)
+
+For the hosted workflow, local images are uploaded to Imagga and classified with
+the V3 `/tags` endpoint using `model=light` and `include_caption=true`. The
+resulting tags/caption and the destination root's current folders are sent to
+Gemini. Gemini selects one safe category name per image, reusing a suitable
+folder where possible and naming a new category otherwise. The organizer creates
+that directory as needed. The shim layer provides one interface for image
+classification, regardless of hosted/local backend, so future modalities can
+reuse the same abstraction.
+
+Run `refactor refactor-images ./incoming --output-dir ./organized` to generate
+fresh context and move the images. Add `--dry-run` to inspect destinations or
+`--copy` to retain the originals.
+
+## Techniques used
+
+- **Recursive traversal with `pathlib`** — [refactor/scanner.py](refactor/scanner.py) uses [`Path.rglob()`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.rglob) to discover nested paths. [refactor/tree.py](refactor/tree.py) recursively walks directory entries to render a text tree.
+
+- **Filesystem metadata from stat data** — [refactor/metadata.py](refactor/metadata.py) reads [`Path.stat()`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) and combines it with path properties such as `name`, `suffix`, and `is_dir()`.
+
+- **Glob-based ignore matching** — [refactor/ignore.py](refactor/ignore.py) loads patterns from an optional `.refactorignore` file and evaluates them with Python’s [`fnmatch`](https://docs.python.org/3/library/fnmatch.html). This keeps ignore rules lightweight while supporting familiar wildcard patterns.
+
+- **Fail-fast input validation** — [refactor/validation.py](refactor/validation.py) validates paths before traversal and checks read permissions with [`os.access()`](https://docs.python.org/3/library/os.html#os.access). CLI commands convert validation failures into clear non-zero exits.
+
+- **Declarative command registration** — [refactor/cli.py](refactor/cli.py) uses decorators to register commands on a Typer application. The package exports the `refactor` command through the console-script entry point in [pyproject.toml](pyproject.toml).
+
+- **Versioning from Git tags** — [pyproject.toml](pyproject.toml) delegates package version discovery to [`setuptools-scm`](https://setuptools-scm.readthedocs.io/). Release versions can come from repository tags instead of being duplicated in source files.
+
+## Technologies and libraries
+
+- [Typer](https://typer.tiangolo.com/) — CLI framework built around Python type hints. It provides command dispatch, help output, and exit handling.
+- [setuptools](https://setuptools.pypa.io/) — package build backend.
+- [setuptools-scm](https://setuptools-scm.readthedocs.io/) — derives the distribution version from source-control metadata.
+- [pathlib](https://docs.python.org/3/library/pathlib.html) — standard-library object model for portable path operations.
+- [importlib.metadata](https://docs.python.org/3/library/importlib.metadata.html) — reads the installed package version at runtime.
+
+The project currently has no web UI, image assets, or bundled fonts.
+
+## Project structure
+
+```text
+.
+├── LICENSE
+├── README.md
+├── pyproject.toml
+└── refactor/
+```
+
+- [refactor/](refactor/) contains the CLI and filesystem logic.
+- [pyproject.toml](pyproject.toml) defines packaging metadata, the `refactor` command, supported Python version, and build configuration.
+- [LICENSE](LICENSE) contains the Apache License 2.0 terms.
+
+## Next steps
+
+The package metadata describes the broader goal as AI-assisted file organization. The next development work can build on the current inspection layer:
+
+- Add an AI integration that proposes organization decisions from scanned metadata.
+- Add a review step so users can inspect proposed changes before any write operation.
+- Implement explicit rename and move operations with dry-run support.
+- Expand ignore handling beyond filename-only matching where needed.
+- Add automated tests for traversal, ignore patterns, validation, and planned write operations.
+- Provide structured scan output for scripts and other tooling.

refactor_cli-0.2.0/README.md

@@ -0,0 +1,95 @@
+# refactor.ai
+
+`refactor.ai` is a Python CLI for inspecting local directories before automating file organization. The package is published as [`refactor-cli`](https://pypi.org/project/refactor-cli/) and targets Python 3.8+.
+
+## Current scope
+
+The CLI entry point in [refactor/cli.py](refactor/cli.py) provides:
+
+- `version` — prints the installed package version.
+- `tree` — prints a recursive directory tree through [refactor/tree.py](refactor/tree.py).
+- `scan` — collects basic file and directory metadata through [refactor/scanner.py](refactor/scanner.py) and [refactor/metadata.py](refactor/metadata.py).
+- `setup` — configures a multimodal backend (`hosted` or `local`), persisted to `~/.refactor/config.json`.
+- `get-image-context` — obtains Imagga V3 tags/captions, asks Gemini to choose a
+  destination category, and writes JSON context.
+- `refactor-images` — automatically refreshes image context, then moves images
+  into Gemini-selected existing or new category folders (`--copy` is available
+  when the originals must be retained).
+- Path checks through [refactor/validation.py](refactor/validation.py), including existence, directory type, and read access.
+- Optional filename exclusions through [refactor/ignore.py](refactor/ignore.py).
+
+On first CLI run, users are prompted to run setup. They can rerun setup anytime with `refactor setup` or edit `~/.refactor/config.json` directly.
+
+## Setup workflow
+
+After installing `refactor-cli`, the first CLI run prompts:
+
+1. **Hosted model (bring your own API keys)**  
+   - Prompts for `IMAGGA_API_KEY`, `IMAGGA_API_SECRET`, and `GEMINI_API_KEY`  
+   - Saves credentials to `~/.refactor/.env` with restricted file permissions
+2. **Local multimodal recommendation (stub)**  
+   - Detects basic hardware (CPU, memory, NVIDIA GPU/VRAM if available)  
+   - Recommends an OSS multimodal model and records it in config  
+   - Uses a local shim stub today (full local runtime integration is a follow-up)
+
+For the hosted workflow, local images are uploaded to Imagga and classified with
+the V3 `/tags` endpoint using `model=light` and `include_caption=true`. The
+resulting tags/caption and the destination root's current folders are sent to
+Gemini. Gemini selects one safe category name per image, reusing a suitable
+folder where possible and naming a new category otherwise. The organizer creates
+that directory as needed. The shim layer provides one interface for image
+classification, regardless of hosted/local backend, so future modalities can
+reuse the same abstraction.
+
+Run `refactor refactor-images ./incoming --output-dir ./organized` to generate
+fresh context and move the images. Add `--dry-run` to inspect destinations or
+`--copy` to retain the originals.
+
+## Techniques used
+
+- **Recursive traversal with `pathlib`** — [refactor/scanner.py](refactor/scanner.py) uses [`Path.rglob()`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.rglob) to discover nested paths. [refactor/tree.py](refactor/tree.py) recursively walks directory entries to render a text tree.
+
+- **Filesystem metadata from stat data** — [refactor/metadata.py](refactor/metadata.py) reads [`Path.stat()`](https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat) and combines it with path properties such as `name`, `suffix`, and `is_dir()`.
+
+- **Glob-based ignore matching** — [refactor/ignore.py](refactor/ignore.py) loads patterns from an optional `.refactorignore` file and evaluates them with Python’s [`fnmatch`](https://docs.python.org/3/library/fnmatch.html). This keeps ignore rules lightweight while supporting familiar wildcard patterns.
+
+- **Fail-fast input validation** — [refactor/validation.py](refactor/validation.py) validates paths before traversal and checks read permissions with [`os.access()`](https://docs.python.org/3/library/os.html#os.access). CLI commands convert validation failures into clear non-zero exits.
+
+- **Declarative command registration** — [refactor/cli.py](refactor/cli.py) uses decorators to register commands on a Typer application. The package exports the `refactor` command through the console-script entry point in [pyproject.toml](pyproject.toml).
+
+- **Versioning from Git tags** — [pyproject.toml](pyproject.toml) delegates package version discovery to [`setuptools-scm`](https://setuptools-scm.readthedocs.io/). Release versions can come from repository tags instead of being duplicated in source files.
+
+## Technologies and libraries
+
+- [Typer](https://typer.tiangolo.com/) — CLI framework built around Python type hints. It provides command dispatch, help output, and exit handling.
+- [setuptools](https://setuptools.pypa.io/) — package build backend.
+- [setuptools-scm](https://setuptools-scm.readthedocs.io/) — derives the distribution version from source-control metadata.
+- [pathlib](https://docs.python.org/3/library/pathlib.html) — standard-library object model for portable path operations.
+- [importlib.metadata](https://docs.python.org/3/library/importlib.metadata.html) — reads the installed package version at runtime.
+
+The project currently has no web UI, image assets, or bundled fonts.
+
+## Project structure
+
+```text
+.
+├── LICENSE
+├── README.md
+├── pyproject.toml
+└── refactor/
+```
+
+- [refactor/](refactor/) contains the CLI and filesystem logic.
+- [pyproject.toml](pyproject.toml) defines packaging metadata, the `refactor` command, supported Python version, and build configuration.
+- [LICENSE](LICENSE) contains the Apache License 2.0 terms.
+
+## Next steps
+
+The package metadata describes the broader goal as AI-assisted file organization. The next development work can build on the current inspection layer:
+
+- Add an AI integration that proposes organization decisions from scanned metadata.
+- Add a review step so users can inspect proposed changes before any write operation.
+- Implement explicit rename and move operations with dry-run support.
+- Expand ignore handling beyond filename-only matching where needed.
+- Add automated tests for traversal, ignore patterns, validation, and planned write operations.
+- Provide structured scan output for scripts and other tooling.

refactor_cli-0.2.0/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "refactor-cli"        # must be unique on PyPI
+dynamic = ["version"]
+description = "CLI tool to organize files using AI"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = ["typer", "requests", "python-dotenv"]
+
+[project.scripts]
+refactor = "refactor.cli:app"
+
+[build-system]
+requires = ["setuptools>=61.0", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]