qwik 0.1.0__tar.gz

qwik-0.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

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

@@ -0,0 +1,39 @@
+name: Test, Build & Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  test-build-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[dev]
+        pip install pytest build twine
+
+    - name: Run tests
+      run: pytest -v
+
+    - name: Build package
+      if: success()
+      run: python -m build
+
+    - name: Publish to PyPI
+      if: success()
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: twine upload dist/*

qwik-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+          pip install pytest
+
+      - name: Run tests
+        run: pytest -q -o addopts=""

qwik-0.1.0/.gitignore

@@ -0,0 +1,123 @@
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+# internal
+log/*
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+jars/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# celery beat schedule file
+celerybeat-schedule
+
+# 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
+
+# End of https://www.gitignore.io/api/python
+
+build/*
+test/data/demand_forecaster/save_model.model
+condaenv.t1e302om.requirements.txt
+
+*.env
+*.aes
+
+# local IDE stuffs
+.idea/*
+.coverage

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

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-merge-conflict
+      - id: no-commit-to-branch
+        args: [--branch, master]
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+
+  # Ruff for both linting and formatting
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.8
+    hooks:
+      - id: ruff
+        args: [--fix]
+        types: [python]
+      - id: ruff-format
+        types: [python]

qwik-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ragil Prasetyo
+
+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.

qwik-0.1.0/PKG-INFO

@@ -0,0 +1,468 @@
+Metadata-Version: 2.4
+Name: qwik
+Version: 0.1.0
+Summary: A Friendly CLI Alias Manager
+Author: qwik contributors
+License: MIT
+License-File: LICENSE
+Keywords: alias,cli,productivity,shell
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: prompt-toolkit>=3.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rapidfuzz>=3.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: tomlkit>=0.12.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: syrupy>=4.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# qwik — A Friendly CLI Alias Manager
+
+Create, manage, and run shell aliases from a single interface. Works cross-platform with bash, zsh, fish, PowerShell, and cmd.
+
+**Two ways to run any alias:**
+- **`gs`** — native shell command (after one-time hook install)
+- **`qwik -r gs`** — works anywhere, no setup needed
+
+---
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Core Concepts](#core-concepts)
+- [Commands](#commands)
+- [Alias Templates & Arguments](#alias-templates--arguments)
+- [Shell Integration](#shell-integration)
+- [Conflict Detection](#conflict-detection)
+- [Storage & Backups](#storage--backups)
+- [Environment Variables](#environment-variables)
+- [Development](#development)
+
+---
+
+## Installation
+
+```bash
+pipx install qwik
+```
+
+Or with `uv`:
+
+```bash
+uv tool install qwik
+```
+
+## Quick Start
+
+```bash
+qwik add gs "git status"
+qwik init zsh --install
+source ~/.zshrc
+
+gs                      # native shell alias
+qwik -r gs               # same thing, no hook needed
+```
+
+## Core Concepts
+
+### Two ways to run
+
+| Way | Example | When to use |
+|---|---|---|
+| **Native** | `gs` | Daily use after one-time shell hook setup |
+| **Via qwik** | `qwik -r gs` | Scripts, CI, restricted shells, or pre-setup |
+
+Both share the **same store and substitution engine** — behavior is identical.
+
+### How it works
+
+1. You **register** aliases with `qwik add`
+2. You **install** a one-line shell hook with `qwik init --install`
+3. Every new shell session **regenerates** shell-native aliases from the store
+4. You type `gs` just like a normal alias — because it is one
+
+---
+
+## Commands
+
+### `add` — Create alias
+
+```bash
+qwik add gs "git status"
+qwik add gs "git status" --tag git --description "Repo status"
+qwik add gs "git status" --force       # overwrite existing
+qwik add                               # interactive mode
+```
+
+### `rm` — Delete alias
+
+```bash
+qwik rm gs
+qwik rm gs --yes                       # skip confirmation
+```
+
+### `rename` — Rename alias
+
+```bash
+qwik rename gs gstat                   # preserves stats
+```
+
+### `edit` — Edit in $EDITOR
+
+```bash
+qwik edit gs
+# Opens TOML snippet in your $EDITOR:
+#   command = "git status"
+#   tag = ["git"]
+#   description = ""
+#   enabled = true
+# Save and quit to apply changes.
+```
+
+### `enable` / `disable` — Toggle without deleting
+
+```bash
+qwik disable gs                        # hides from shell hook
+qwik enable gs                         # re-enables
+```
+
+### `list` — Pretty table
+
+```bash
+qwik list                              # all aliases
+qwik -l                                # shortcut
+qwik list --tag git                    # filter by tag
+qwik list --search stat                # filter by query
+```
+
+Output:
+
+```
+  Name   Command                     Tag    Used   Last
+ ─────  ──────────────────────────  ─────  ─────  ───────────
+  gs     git status                  git     42     2 min ago
+  gco    git checkout {1}            git     18     1 hour ago
+  k      kubectl                     k8s      7     yesterday
+```
+
+### `show` — Detailed view
+
+```bash
+qwik show gs                           # full metadata
+```
+
+### `search` — Fuzzy search
+
+```bash
+qwik search "git"
+qwik -s "git"                          # shortcut
+```
+
+### `pick` — Interactive fuzzy picker
+
+```bash
+qwik                                   # bare invocation
+qwik pick
+```
+
+- Type characters to filter matching aliases live
+- `↑`/`↓` navigate
+- `Enter` runs the selected alias
+- `Ctrl+E` edits it
+- `Ctrl+D` deletes it
+- `Esc` cancels
+
+### `run` — Execute alias
+
+```bash
+qwik run gs
+qwik run gs --short                    # pass extra args
+qwik -r gs --short                     # shortcut flag
+```
+
+### `tag` / `untag`
+
+```bash
+qwik tag gs git
+qwik tag gs work
+qwik untag gs work
+```
+
+### `export` / `import`
+
+```bash
+qwik export ~/aliases.toml             # share / backup
+qwik import ~/aliases.toml             # merge
+qwik import ~/aliases.toml --overwrite
+```
+
+### `doctor` — Health check
+
+```bash
+qwik doctor                            # shell, hook, store, conflicts
+```
+
+### `init` — Shell hook
+
+```bash
+qwik init zsh                          # print hook to stdout
+qwik init zsh --install                # append to ~/.zshrc with backup
+```
+
+Supported shells: `bash`, `zsh`, `fish`, `pwsh`.
+
+### Version & Help
+
+```bash
+qwik --version
+qwik -v
+qwik --help
+qwik -h
+```
+
+---
+
+## Alias Templates & Arguments
+
+Aliases can pass arguments through unchanged or interpolate them into the command.
+
+### Append mode (default — no placeholders)
+
+Extra args are appended after quoting.
+
+```bash
+qwik add gs "git status"
+gs --short              # → git status --short
+```
+
+### Template mode (placeholders)
+
+Use `{…}` markers to substitute arguments into the command.
+
+| Placeholder | Meaning |
+|---|---|
+| `{1}`, `{2}`, `{3}`… | Nth positional argument (1-based) |
+| `{@}` | All arguments joined with spaces |
+| `{*}` | All arguments as a single quoted string |
+| `{1:-default}` | Nth positional, falling back to `default` if missing |
+
+---
+
+**Single positional:**
+
+```bash
+qwik add gco "git checkout {1}"
+gco main                # → git checkout main
+```
+
+**Multiple positionals:**
+
+```bash
+qwik add gcm 'git commit -m "{1}: {2}"'
+gcm feat "add login"
+# → git commit -m "feat: add login"
+```
+
+**Default value:**
+
+```bash
+qwik add gpo "git push origin {1:-main}"
+gpo                     # → git push origin main
+gpo feature/x           # → git push origin feature/x
+```
+
+**All args joined:**
+
+```bash
+qwik add gc-chore 'git commit -m "chore: {@}"'
+gc-chore init version
+# → git commit -m "chore: init version"
+```
+
+**All args as one quoted string:**
+
+```bash
+qwik add note 'echo "Note: {*}"'
+note hello world
+# → echo "Note: 'hello world'"
+```
+
+**Mixed — template + appended extras:**
+
+```bash
+qwik add k "kubectl {1}"
+k get pods -n kube-system
+# → kubectl get pods -n kube-system
+#     {1}=get, "pods -n kube-system" appended after template
+```
+
+---
+
+### Placeholder defaults
+
+`{N:-default}` is especially useful for aliases with a sensible fallback:
+
+```bash
+qwik add co "git checkout {1:-main}"
+co feature              # → git checkout feature
+co                      # → git checkout main (default)
+```
+
+### Validation
+
+- `{0}` is rejected at add-time — placeholders are 1-based
+- Missing required args produce a clear error at runtime instead of silently expanding to empty strings
+
+---
+
+## Shell Integration
+
+Make aliases available as **real shell commands**.
+
+### One-time setup
+
+**bash:**
+
+```bash
+qwik init bash --install
+source ~/.bashrc
+```
+
+**zsh:**
+
+```bash
+qwik init zsh --install
+source ~/.zshrc
+```
+
+**fish:**
+
+```bash
+qwik init fish --install
+source ~/.config/fish/config.fish
+```
+
+**PowerShell:**
+
+```powershell
+qwik init pwsh --install
+```
+
+The `--install` flag:
+- Creates a timestamped backup of your rc file
+- Appends the hook (idempotent — safe to run multiple times)
+
+### Manual setup
+
+If you prefer to edit your rc file directly, `qwik init <shell>` prints the hook:
+
+```bash
+eval "$(qwik init zsh)"
+```
+
+### Per-shell rendering
+
+The hook generates native aliases/functions for each shell:
+
+| Shell | Append mode | Template mode |
+|---|---|---|
+| bash / zsh | `alias gs='git status'` | `gs() { git checkout "$1" ; }` |
+| fish | `alias gs 'git status'` | `function gs ; … ; end` |
+| PowerShell | `function gs { echo hi @args }` | `function gs { echo "{1}" $args[0] }` |
+| cmd | `doskey gs=git status $*` | (best-effort, no template) |
+
+---
+
+## Conflict Detection
+
+Every `add` and `rename` validates the new name:
+
+| # | Check | Result |
+|---|---|---|
+| 1 | Already an alias? | Refuse unless `--force` |
+| 2 | Shell builtin? (`cd`, `echo`, `alias`, …) | Refuse unless `--force` |
+| 3 | Binary on `$PATH`? | Warn but allow |
+| 4 | Valid syntax? | Refuse if it contains spaces, slashes, `$`, backticks, semicolons |
+
+Example UX:
+
+```bash
+qwik add ls "ls --color=auto"
+⚠ Warning: "ls" shadows /usr/bin/ls.
+  Continue? [y/N]
+
+qwik add cd "echo nope"
+✗ "cd" is a shell builtin. Shadowing it can break your shell.
+
+qwik add "my alias" "echo hi"
+✗ Invalid name "my alias": contains whitespace.
+```
+
+---
+
+## Storage & Backups
+
+- **Linux/macOS:** `$XDG_CONFIG_HOME/qwik/aliases.toml` (usually `~/.config/qwik/aliases.toml`)
+- **Windows:** `%APPDATA%\qwik\aliases.toml`
+- **Backups:** every destructive operation writes to `qwik/backups/aliases-<timestamp>.toml` (last 20 kept)
+- **Atomic writes:** temp file + rename to prevent corruption
+- **Format:** human-readable TOML, safe to edit by hand
+
+Example store file:
+
+```toml
+[aliases.gs]
+command = "git status"
+tag = ["git"]
+description = "Quick git status"
+enabled = true
+created_at = "2026-05-10T10:00:00Z"
+updated_at = "2026-05-10T10:00:00Z"
+last_used = "2026-05-10T11:30:00Z"
+run_count = 42
+```
+
+---
+
+## Environment Variables
+
+| Variable | Purpose |
+|---|---|
+| `EDITOR` | Editor for `qwik edit` (default: `vi`) |
+| `QWIK_CONFIG_DIR` | Override default config directory |
+| `QWIK_DEBUG=1` | Enable debug logs to stderr |
+| `NO_COLOR` | Disable colored output (also `--no-color`) |
+
+---
+
+## Development
+
+```bash
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Run the test suite
+pytest
+
+# With coverage report
+pytest --cov=qwik --cov-report=term-missing
+```
+
+---
+
+## License
+
+MIT