shortcake 0.1.0__tar.gz

shortcake-0.1.0/.claude/settings.local.json

@@ -0,0 +1,13 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(pytest:*)",
+      "Bash(uv run pytest:*)",
+      "Bash(uv run:*)",
+      "Bash(uv add:*)",
+      "Bash(python3:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

shortcake-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.14"]
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras --dev
+
+      - name: Run tests
+        run: |
+          uv run pytest tests/ -v
+
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v5
+      - uses: j178/prek-action@v1/action@v3.0.0

shortcake-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# 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
+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__/

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

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-merge-conflict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.9
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

shortcake-0.1.0/CLAUDE.md

@@ -0,0 +1,2 @@
+- Don't add docstrings for basic things, like tests
+- Always use test function and not classes, make multiple files if needed

shortcake-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Patrick Arminio
+
+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.

shortcake-0.1.0/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: shortcake
+Version: 0.1.0
+Summary: A CLI built with typer and uv
+License-File: LICENSE
+Requires-Python: >=3.14
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rtoml>=0.11.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# shortcake
+
+A CLI application built with [typer](https://typer.tiangolo.com/) and [uv](https://docs.astral.sh/uv/), supporting only Python 3.14.
+
+## Requirements
+
+- Python 3.14+
+- uv package manager
+
+## Installation
+
+Install dependencies using uv:
+
+```bash
+uv sync
+```
+
+## Usage
+
+Run the CLI using uv:
+
+```bash
+# Show help
+uv run shortcake --help
+
+# Say hello with default greeting
+uv run shortcake hello
+
+# Say hello with custom name
+uv run shortcake hello --name "Patrick"
+
+# Show version
+uv run shortcake version
+```
+
+## Commands
+
+### `hello`
+Say hello to someone.
+
+Options:
+- `--name TEXT`: Name to greet (default: "World")
+
+### `version`
+Show the current version of shortcake.
+
+### `create`
+Create a stack with a new branch and commit.
+
+This command helps you create stacked PRs by:
+1. Creating a temporary branch
+2. Opening your configured editor ($EDITOR) to compose the commit message (emojis are fully supported! 🎉)
+3. Creating the commit
+4. Generating a branch name from the commit message (lowercase, hyphenated, alphanumeric only)
+5. Renaming the temporary branch to the final branch name
+
+**Important:** Stage your changes with `git add` before running this command. Only staged changes will be committed.
+
+**Emoji Support:**
+- Commit messages fully support emojis
+- Emoji handling in branch names is controlled by the `keep_emoji` configuration setting
+- Use `shortcake config set keep_emoji true` to preserve emojis in branch names
+- Use `shortcake config set keep_emoji false` to remove emojis from branch names (default)
+
+**Note:** Future enhancement will include gitmoji integration for conventional emoji commits.
+
+Example:
+```bash
+# Stage your changes first
+git add .
+
+# Basic usage (emojis removed from branch name by default)
+uv run shortcake create
+# Opens your editor to compose commit message
+# Type: 🚀 Add rocket feature
+# Save and close
+# Creates commit: 🚀 Add rocket feature
+# Creates branch: add-rocket-feature
+
+# Configure to keep emojis in branch names
+uv run shortcake config set keep_emoji true
+
+# Stage changes and create
+git add .
+uv run shortcake create
+# Opens your editor to compose commit message
+# Type: 🔥 Add fire feature
+# Save and close
+# Creates commit: 🔥 Add fire feature
+# Creates branch: 🔥-add-fire-feature
+```
+
+### `edit` / `modify`
+Edit the current stack by amending the commit.
+
+This command helps you modify the current stack by amending the previous commit without opening an editor.
+
+**Important:** Stage your changes with `git add` before running this command. Only staged changes will be amended.
+
+Example:
+```bash
+# Make some changes to your files
+echo "more content" >> file.txt
+
+# Stage your changes first
+git add .
+
+# Amend the previous commit
+uv run shortcake edit
+# Successfully amended the commit (reuses previous commit message)
+
+# Or use the modify alias
+uv run shortcake modify
+```
+
+### `config`
+Manage shortcake configuration settings.
+
+Configuration is stored in `~/.shortcake/config.json` in your home directory.
+
+Available settings:
+- `keep_emoji`: Whether to keep emojis in branch names (true/false, default: false)
+
+**Actions:**
+- `list` - List all configuration settings
+- `get <key>` - Get a specific configuration value
+- `set <key> <value>` - Set a configuration value
+
+Example:
+```bash
+# List all configuration
+uv run shortcake config list
+
+# Get a specific setting
+uv run shortcake config get keep_emoji
+
+# Set keep_emoji to true
+uv run shortcake config set keep_emoji true
+
+# Set keep_emoji to false
+uv run shortcake config set keep_emoji false
+```
+
+## Development
+
+This project uses uv for dependency management and requires Python 3.14 or higher.

shortcake-0.1.0/README.md

@@ -0,0 +1,146 @@
+# shortcake
+
+A CLI application built with [typer](https://typer.tiangolo.com/) and [uv](https://docs.astral.sh/uv/), supporting only Python 3.14.
+
+## Requirements
+
+- Python 3.14+
+- uv package manager
+
+## Installation
+
+Install dependencies using uv:
+
+```bash
+uv sync
+```
+
+## Usage
+
+Run the CLI using uv:
+
+```bash
+# Show help
+uv run shortcake --help
+
+# Say hello with default greeting
+uv run shortcake hello
+
+# Say hello with custom name
+uv run shortcake hello --name "Patrick"
+
+# Show version
+uv run shortcake version
+```
+
+## Commands
+
+### `hello`
+Say hello to someone.
+
+Options:
+- `--name TEXT`: Name to greet (default: "World")
+
+### `version`
+Show the current version of shortcake.
+
+### `create`
+Create a stack with a new branch and commit.
+
+This command helps you create stacked PRs by:
+1. Creating a temporary branch
+2. Opening your configured editor ($EDITOR) to compose the commit message (emojis are fully supported! 🎉)
+3. Creating the commit
+4. Generating a branch name from the commit message (lowercase, hyphenated, alphanumeric only)
+5. Renaming the temporary branch to the final branch name
+
+**Important:** Stage your changes with `git add` before running this command. Only staged changes will be committed.
+
+**Emoji Support:**
+- Commit messages fully support emojis
+- Emoji handling in branch names is controlled by the `keep_emoji` configuration setting
+- Use `shortcake config set keep_emoji true` to preserve emojis in branch names
+- Use `shortcake config set keep_emoji false` to remove emojis from branch names (default)
+
+**Note:** Future enhancement will include gitmoji integration for conventional emoji commits.
+
+Example:
+```bash
+# Stage your changes first
+git add .
+
+# Basic usage (emojis removed from branch name by default)
+uv run shortcake create
+# Opens your editor to compose commit message
+# Type: 🚀 Add rocket feature
+# Save and close
+# Creates commit: 🚀 Add rocket feature
+# Creates branch: add-rocket-feature
+
+# Configure to keep emojis in branch names
+uv run shortcake config set keep_emoji true
+
+# Stage changes and create
+git add .
+uv run shortcake create
+# Opens your editor to compose commit message
+# Type: 🔥 Add fire feature
+# Save and close
+# Creates commit: 🔥 Add fire feature
+# Creates branch: 🔥-add-fire-feature
+```
+
+### `edit` / `modify`
+Edit the current stack by amending the commit.
+
+This command helps you modify the current stack by amending the previous commit without opening an editor.
+
+**Important:** Stage your changes with `git add` before running this command. Only staged changes will be amended.
+
+Example:
+```bash
+# Make some changes to your files
+echo "more content" >> file.txt
+
+# Stage your changes first
+git add .
+
+# Amend the previous commit
+uv run shortcake edit
+# Successfully amended the commit (reuses previous commit message)
+
+# Or use the modify alias
+uv run shortcake modify
+```
+
+### `config`
+Manage shortcake configuration settings.
+
+Configuration is stored in `~/.shortcake/config.json` in your home directory.
+
+Available settings:
+- `keep_emoji`: Whether to keep emojis in branch names (true/false, default: false)
+
+**Actions:**
+- `list` - List all configuration settings
+- `get <key>` - Get a specific configuration value
+- `set <key> <value>` - Set a configuration value
+
+Example:
+```bash
+# List all configuration
+uv run shortcake config list
+
+# Get a specific setting
+uv run shortcake config get keep_emoji
+
+# Set keep_emoji to true
+uv run shortcake config set keep_emoji true
+
+# Set keep_emoji to false
+uv run shortcake config set keep_emoji false
+```
+
+## Development
+
+This project uses uv for dependency management and requires Python 3.14 or higher.

shortcake-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "shortcake"
+version = "0.1.0"
+description = "A CLI built with typer and uv"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "typer>=0.9.0",
+    "pydantic>=2.0.0",
+    "rtoml>=0.11.0",
+]
+
+[project.scripts]
+shortcake = "shortcake.cli:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "inline-snapshot>=0.13.0",
+    "ruff>=0.1.0",
+    "pre-commit>=3.0.0",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+ignore = [
+    "E501",  # line too long (handled by line-length setting)
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

shortcake-0.1.0/shortcake/__init__.py

@@ -0,0 +1,3 @@
+"""Shortcake CLI package."""
+
+__version__ = "0.1.0"