pikapika-organizer 0.7.0

Pikapika - A Python CLI utility to organize your files by extension

Pikapika Organizer — Downloads Folder Organizer

Automatically organize your files by extension with one command

📚 View Documentation | 🐍 PyPI Package | 🐛 Report Issues

“Pika Pika (ピカピカ)” is an onomatopoeia in Japanese, meaning “shiny” or “sparkly”. This project is mainly used to clean your folders of clutter and manage them efficiently. It automatically files items into category folders (Images, Documents, Archives, Installers, etc.) and optionally quarantines junk files such as partial downloads.

Built with Python 3.13 and the uv workflow.

---

Features

• Dry run mode (--dry-run) shows every planned move before mutating files.
• Category routing using an editable extension map in src/pikapika/__init__.py.
• Junk handling for extensions like .crdownload, .tmp, .part: quarantine them or send them to the Recycle Bin (via send2trash).
• Duplicate safety — automatically renames conflicts (file (1).pdf).
• Recursive mode to organize nested folders while skipping known system directories (.git, __pycache__, etc.).

---

Requirements

• Python 3.13+
• uv for dependency and virtualenv management

Optional:

• send2trash (installed automatically) if you want junk files to go to the system trash instead of _Quarantine.

---

Installation

pip install pikapika-organizer

Install from GitHub Packages

uv add --index-url https://python.pkg.github.com/arizmuajianisan/ pikapika-organizer

Or for temporary installation:

uv pip install --index-url https://python.pkg.github.com/arizmuajianisan/ pikapika-organizer

Useful helpers are available via make:

make help
# test, check, format, run, clean, ...

If you prefer plain commands:

uv run pytest              # run tests
uv run ruff check          # lint
uv run ruff format         # format
uv run pikapika-organizer --dry-run  # execute CLI

---

Usage

Run commands from the project root (or install the package and use the pikapika-organizer entry point globally).

uv run pikapika-organizer --help

Common flags

Flag	Description
--path PATH	Downloads directory to organize. Defaults to the current user's Downloads.
--dry-run	Print intended operations without touching the filesystem.
--recursive	Walk subdirectories (skips known system folders automatically).
--quarantine-junk	Move old junk files to _Quarantine.
--junk-days N	Minimum age (days) for junk files before action (default: 7).
--trash-junk	Send junk files to the OS trash (requires send2trash).

Examples

# Preview current user's Downloads
uv run pikapika-organizer --dry-run

# Organize a specific folder for real
uv run pikapika-organizer --path "D:\Downloads" 

# Go recursive and quarantine stale junk (>= 10 days old)
uv run pikapika-organizer --recursive --quarantine-junk --junk-days 10

# Send junk to Recycle Bin instead of _Quarantine
uv run pikapika-organizer --quarantine-junk --trash-junk

---

Customizing categories

Edit the CATEGORIES dictionary in src/pikapika_organizer/__init__.py:

CATEGORIES = {
    "Images": {".png", ".jpg", ".svg"},
    "Documents": {".pdf", ".docx", ".md"},
    "Archives": {".zip", ".iso"},
}

Add or rename folders, or introduce new buckets (e.g., "DesignAssets", "DiskImages"). Always run with --dry-run after changes to verify they behave as expected.

---

Development workflow

uv sync --group dev   # install everything
make check            # lint (ruff)
make format           # format (ruff fmt)
make test             # run pytest suite
make run              # run CLI in-place

The test suite (tests/test_pikapika.py) covers:

• extension categorization
• duplicate handling
• junk quarantine/trash flow
• recursive traversal and skip logic

---

Release Process

This project uses automated releases via GitHub Actions, similar to release-it for JavaScript projects.

Quick Release (Recommended)

# Patch release (bug fixes)
make release-patch

# Minor release (new features)
make release-minor

# Major release (breaking changes)
make release-major

Manual Release Steps

# 1. Run the release script
uv run python scripts/release.py patch

# 2. The script will:
#    - Check git status is clean
#    - Run tests and linting
#    - Update version in pyproject.toml
#    - Build package
#    - Create and push git tag (e.g., v0.1.1)

# 3. GitHub Actions will automatically:
#    - Run comprehensive tests
#    - Build and validate package
#    - Publish to TestPyPI
#    - Verify TestPyPI installation
#    - Publish to production PyPI
#    - Create GitHub Release with changelog

Dry Run Mode

# Preview what would happen without making changes
uv run python scripts/release.py patch --dry-run

Release Workflow Details

• Trigger: Git tags starting with v (e.g., v0.1.0, v1.2.3)
• Testing: Multi-platform tests (Ubuntu, Windows, macOS)
• Publishing: TestPyPI → PyPI (with verification)
• Release Notes: Auto-generated changelog from git commits
• Badges: Updated automatically after release

---

Troubleshooting

• Hardlink warning during uv sync
  Set UV_LINK_MODE=copy (or run with uv sync --link-mode=copy) when working across filesystems that do not support hardlinks.

• --trash-junk no-ops
  Ensure send2trash is installed (it is pulled in automatically when using uv sync --group dev). On Windows you might need to reopen the shell after installation.

• Downloads path seems wrong
  Supply an explicit path with --path when using redirected or network-backed folders.

---

License

MIT — see the LICENSE file for details. Feel free to fork, tweak, and ship improvements. Contributions welcome!