iterm2-focus 0.0.1__tar.gz

iterm2_focus-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,123 @@
+name: CI
+
+on:
+  push:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv python install 3.13
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run ruff
+        run: |
+          uv run ruff check src tests
+          uv run ruff format --check src tests
+
+      - name: Run black
+        run: uv run black --check src tests
+
+      - name: Run mypy
+        run: uv run mypy src
+
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest -v --cov=iterm2_focus --cov-report=xml --cov-report=term
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.13'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Build package
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Check dist
+        run: |
+          ls -la dist/
+          uv run twine check dist/*
+
+  publish:
+    name: Publish to PyPI
+    needs: [lint, test, build]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/iterm2-focus
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

iterm2_focus-0.0.1/.gitignore

@@ -0,0 +1,218 @@
+# 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__/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# uv
+.uv/

iterm2_focus-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributing to iterm2-focus
+
+Thank you for your interest in contributing to iterm2-focus! This document provides guidelines and instructions for contributing.
+
+## Development Setup
+
+1. **Fork and clone the repository**
+   ```bash
+   git clone https://github.com/YOUR-USERNAME/iterm2-focus
+   cd iterm2-focus
+   ```
+
+2. **Install uv (if not already installed)**
+   ```bash
+   curl -LsSf https://astral.sh/uv/install.sh | sh
+   ```
+
+3. **Create a virtual environment and install dependencies**
+   ```bash
+   uv venv
+   uv sync --all-extras --dev
+   ```
+
+4. **Install pre-commit hooks (optional but recommended)**
+   ```bash
+   uv run pre-commit install
+   ```
+
+## Running Tests
+
+```bash
+# Run all tests
+uv run pytest
+
+# Run with coverage
+uv run pytest --cov=iterm2_focus
+
+# Run specific test file
+uv run pytest tests/test_focus.py
+
+# Run with verbose output
+uv run pytest -v
+```
+
+## Code Quality
+
+Before submitting a pull request, ensure your code passes all quality checks:
+
+```bash
+# Format code
+uv run black src tests
+uv run ruff format src tests
+
+# Check linting
+uv run ruff check src tests
+
+# Type checking
+uv run mypy src
+
+# Run all checks at once
+uv run black src tests && uv run ruff check src tests && uv run mypy src && uv run pytest
+```
+
+## Testing the CLI
+
+During development, you can test the CLI using:
+
+```bash
+# Using uv run
+uv run isf --help
+uv run isf --list
+
+# Or activate the virtual environment
+source .venv/bin/activate
+isf --help
+```
+
+## Pull Request Process
+
+1. **Create a feature branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make your changes**
+   - Write clear, concise commit messages
+   - Add tests for new functionality
+   - Update documentation as needed
+
+3. **Ensure all tests pass**
+   ```bash
+   uv run pytest
+   uv run mypy src
+   ```
+
+4. **Push your branch and create a pull request**
+   - Provide a clear description of your changes
+   - Reference any related issues
+   - Ensure CI passes
+
+## Code Style
+
+- Follow PEP 8
+- Use type hints for all functions
+- Maximum line length: 88 characters (Black default)
+- Use descriptive variable and function names
+
+## Testing Guidelines
+
+- Write tests for all new functionality
+- Maintain or improve code coverage
+- Use pytest fixtures for test setup
+- Mock external dependencies (especially iTerm2 API calls)
+
+## Documentation
+
+- Update README.md if adding new features
+- Add docstrings to all public functions and classes
+- Include type hints in function signatures
+
+## Release Process
+
+Releases are automated through GitHub Actions:
+
+1. Update version in `pyproject.toml` and `src/iterm2_focus/__init__.py`
+2. Create a PR with version changes
+3. After merging, create a GitHub release with tag `v{version}`
+4. CI will automatically publish to PyPI
+
+## Questions?
+
+Feel free to open an issue for any questions or concerns!

iterm2_focus-0.0.1/LICENSE

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

iterm2_focus-0.0.1/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.4
+Name: iterm2-focus
+Version: 0.0.1
+Summary: Focus iTerm2 sessions by ID
+Project-URL: Homepage, https://github.com/mkusaka/iterm2-focus
+Project-URL: Bug Tracker, https://github.com/mkusaka/iterm2-focus/issues
+Project-URL: Documentation, https://github.com/mkusaka/iterm2-focus#readme
+Project-URL: Source Code, https://github.com/mkusaka/iterm2-focus
+Author-email: mkusaka <hinoshita1992@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: cli,focus,iterm2,macos,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: MacOS X
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: click>=8.1.0
+Requires-Dist: iterm2>=2.7
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.11.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Requires-Dist: types-click>=7.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# iterm2-focus
+
+Focus iTerm2 sessions by ID from the command line.
+
+## Features
+
+- Focus any iTerm2 session by its ID
+- Get the current session ID
+- List all available sessions
+- Focus the current session (useful when returning from other applications)
+
+## Installation
+
+```bash
+pip install iterm2-focus
+```
+
+Or using [uv](https://github.com/astral-sh/uv):
+
+```bash
+uv pip install iterm2-focus
+```
+
+## Prerequisites
+
+1. **macOS** with iTerm2 installed
+2. **Python 3.8** or later
+3. **iTerm2 Python API** must be enabled:
+   - Open iTerm2
+   - Go to *Settings* → *General* → *Magic*
+   - Check "Enable Python API"
+   - Restart iTerm2
+
+## Usage
+
+### Focus a specific session
+
+```bash
+isf w0t0p0:12345678-1234-1234-1234-123456789012
+```
+
+### Focus the current session
+
+Useful when returning from another application:
+
+```bash
+isf --current
+# or
+isf -c
+```
+
+### Get the current session ID
+
+```bash
+isf --get-current
+# or
+isf -g
+```
+
+### List all sessions
+
+```bash
+isf --list
+# or
+isf -l
+```
+
+### Additional options
+
+```bash
+# Show version
+isf --version
+
+# Quiet mode (suppress output)
+isf -q <session-id>
+
+# Help
+isf --help
+```
+
+## Examples
+
+### Save and restore focus
+
+```bash
+# Save current session ID
+SAVED_SESSION=$(isf -g -q)
+
+# ... do other work ...
+
+# Return to saved session
+isf $SAVED_SESSION
+```
+
+### Focus a session from another application
+
+```applescript
+-- AppleScript example
+do shell script "isf w0t0p0:12345678-1234-1234-1234-123456789012"
+```
+
+## Development
+
+### Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/mkusaka/iterm2-focus
+cd iterm2-focus
+
+# Create virtual environment with uv
+uv venv
+uv pip install -e ".[dev]"
+```
+
+### Testing
+
+```bash
+# Run tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=iterm2_focus
+
+# Type checking
+uv run mypy src
+
+# Linting and formatting
+uv run ruff check src tests
+uv run black src tests
+```
+
+### Building
+
+```bash
+# Build the package
+uv build
+
+# Upload to PyPI
+uv publish
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Troubleshooting
+
+### "Failed to connect to iTerm2" error
+
+Make sure iTerm2's Python API is enabled (see Prerequisites).
+
+### "Session not found" error
+
+Verify the session ID using `isf --list` to see all available sessions.
+
+### Permission errors
+
+On first run, macOS may ask for permission to control iTerm2. Please allow this in System Preferences.
+
+## Author
+
+mkusaka <hinoshita1992@gmail.com>