gitignorio-cli 0.1.0__tar.gz

gitignorio_cli-0.1.0/.gitignore

@@ -0,0 +1,200 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.codedb/
+codedb.snapshot
+.idea/
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/

gitignorio_cli-0.1.0/LICENSE.md

@@ -0,0 +1,9 @@
+Created by Isaac AR
+Copyright © 2026, Fortis & Vincere.
+
+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.
+No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
+
+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.

gitignorio_cli-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: gitignorio-cli
+Version: 0.1.0
+Summary: Create and update .gitignore files using gitignore.io with automatic language detection
+License-File: LICENSE.md
+Requires-Python: >=3.11
+Requires-Dist: typer>=0.12.0
+Description-Content-Type: text/markdown
+
+# gitignorio-cli
+
+Create and update `.gitignore` files using [gitignore.io](https://www.toptal.com/developers/gitignore) with automatic language detection.
+
+Install from PyPI:
+
+```bash
+pip install gitignorio-cli
+# or
+uv tool install gitignorio-cli
+```
+
+For local development:
+
+```bash
+uv tool install .
+# or
+pip install .
+```
+
+## Usage
+
+The command is `gi`:
+
+```bash
+gi create              # OS template + detected languages
+gi create --no-detect  # OS template only
+gi update              # append newly detected languages
+gi add python node     # append specific templates
+gi list                # list available templates
+gi hooks install       # auto-create/update .gitignore via git hooks
+```
+
+Use `--path` / `-p` to target a directory other than the current one.
+
+## Git hooks
+
+Install hooks once per repository (or use `--global` to seed new repos created with `git init`):
+
+```bash
+gi hooks install
+gi hooks install --global
+```
+
+This installs:
+
+- **post-checkout** — creates `.gitignore` when a repository is initialized (clone/checkout) if one does not exist
+- **pre-push** — updates `.gitignore` before each push, or creates it if missing
+
+Existing hook scripts managed by gitignore-cli are updated in place. Other hook scripts are left intact and receive an appended gitignore-cli block.
+
+Running `gi hooks install` also creates `.gitignore` immediately when it is missing in the current repository.
+
+## Language detection
+
+`create` and `update` use [github-linguist](https://github.com/github-linguist/linguist) and [magika](https://github.com/google/magika). The CLI installs them automatically on first run if Ruby `gem` and `pipx` are available.
+
+## License
+
+MIT — see [LICENSE.md](LICENSE.md).
+
+Templates are bundled locally (sourced from [gitignore.io](https://www.toptal.com/developers/gitignore)) and work offline. To refresh them:
+
+```bash
+python scripts/download_templates.py
+```
+
+Generated `.gitignore` content is [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

gitignorio_cli-0.1.0/README.md

@@ -0,0 +1,68 @@
+# gitignorio-cli
+
+Create and update `.gitignore` files using [gitignore.io](https://www.toptal.com/developers/gitignore) with automatic language detection.
+
+Install from PyPI:
+
+```bash
+pip install gitignorio-cli
+# or
+uv tool install gitignorio-cli
+```
+
+For local development:
+
+```bash
+uv tool install .
+# or
+pip install .
+```
+
+## Usage
+
+The command is `gi`:
+
+```bash
+gi create              # OS template + detected languages
+gi create --no-detect  # OS template only
+gi update              # append newly detected languages
+gi add python node     # append specific templates
+gi list                # list available templates
+gi hooks install       # auto-create/update .gitignore via git hooks
+```
+
+Use `--path` / `-p` to target a directory other than the current one.
+
+## Git hooks
+
+Install hooks once per repository (or use `--global` to seed new repos created with `git init`):
+
+```bash
+gi hooks install
+gi hooks install --global
+```
+
+This installs:
+
+- **post-checkout** — creates `.gitignore` when a repository is initialized (clone/checkout) if one does not exist
+- **pre-push** — updates `.gitignore` before each push, or creates it if missing
+
+Existing hook scripts managed by gitignore-cli are updated in place. Other hook scripts are left intact and receive an appended gitignore-cli block.
+
+Running `gi hooks install` also creates `.gitignore` immediately when it is missing in the current repository.
+
+## Language detection
+
+`create` and `update` use [github-linguist](https://github.com/github-linguist/linguist) and [magika](https://github.com/google/magika). The CLI installs them automatically on first run if Ruby `gem` and `pipx` are available.
+
+## License
+
+MIT — see [LICENSE.md](LICENSE.md).
+
+Templates are bundled locally (sourced from [gitignore.io](https://www.toptal.com/developers/gitignore)) and work offline. To refresh them:
+
+```bash
+python scripts/download_templates.py
+```
+
+Generated `.gitignore` content is [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

gitignorio_cli-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "gitignorio-cli"
+version = "0.1.0"
+description = "Create and update .gitignore files using gitignore.io with automatic language detection"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "typer>=0.12.0",
+]
+
+[project.scripts]
+gi = "gitignore_cli.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gitignore_cli"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/gitignore_cli", "pyproject.toml", "README.md", "scripts/download_templates.py"]

gitignorio_cli-0.1.0/scripts/download_templates.py

@@ -0,0 +1,130 @@
+#!/usr/bin/env python3
+"""Download gitignore.io templates into the bundled data directory."""
+
+from __future__ import annotations
+
+import json
+import sys
+import time
+import urllib.error
+import urllib.request
+from concurrent.futures import ThreadPoolExecutor, as_completed
+from datetime import UTC, datetime
+from pathlib import Path
+
+API_BASE = "https://www.toptal.com/developers/gitignore/api"
+ROOT = Path(__file__).resolve().parents[1]
+DATA_DIR = ROOT / "src" / "gitignore_cli" / "data"
+TEMPLATES_DIR = DATA_DIR / "templates"
+USER_AGENT = "gitignore-cli-template-sync/1.0"
+MAX_WORKERS = 4
+MAX_ATTEMPTS = 5
+
+
+def fetch_text(url: str) -> str:
+    last_error: Exception | None = None
+    for attempt in range(MAX_ATTEMPTS):
+        request = urllib.request.Request(url, headers={"User-Agent": USER_AGENT})
+        try:
+            with urllib.request.urlopen(request, timeout=60) as response:
+                return response.read().decode("utf-8")
+        except urllib.error.HTTPError as exc:
+            last_error = exc
+            if exc.code in {403, 429, 503} and attempt + 1 < MAX_ATTEMPTS:
+                time.sleep(0.5 * (2**attempt))
+                continue
+            raise
+        except OSError as exc:
+            last_error = exc
+            if attempt + 1 < MAX_ATTEMPTS:
+                time.sleep(0.5 * (2**attempt))
+                continue
+            raise
+    assert last_error is not None
+    raise last_error
+
+
+def download_template(name: str) -> tuple[str, str | None, str | None]:
+    try:
+        content = fetch_text(f"{API_BASE}/{name}")
+        return name, content, None
+    except urllib.error.HTTPError as exc:
+        return name, None, f"HTTP {exc.code}"
+    except OSError as exc:
+        return name, None, str(exc)
+
+
+def download_all(templates: list[str]) -> tuple[int, list[str]]:
+    failures: list[str] = []
+    downloaded = 0
+    pending = [
+        name
+        for name in templates
+        if not (TEMPLATES_DIR / f"{name}.gitignore").exists()
+    ]
+    if not pending:
+        return 0, []
+
+    with ThreadPoolExecutor(max_workers=MAX_WORKERS) as pool:
+        futures = {pool.submit(download_template, name): name for name in pending}
+        for index, future in enumerate(as_completed(futures), start=1):
+            name, content, error = future.result()
+            if error or content is None:
+                failures.append(f"{name}: {error}")
+                continue
+            (TEMPLATES_DIR / f"{name}.gitignore").write_text(content, encoding="utf-8")
+            downloaded += 1
+            if index % 50 == 0 or index == len(pending):
+                print(f"  {index}/{len(pending)}")
+    return downloaded, failures
+
+
+def main() -> int:
+    DATA_DIR.mkdir(parents=True, exist_ok=True)
+    TEMPLATES_DIR.mkdir(parents=True, exist_ok=True)
+
+    print("Fetching template list...")
+    template_list = fetch_text(f"{API_BASE}/list?format=lines")
+    templates = [line.strip().lower() for line in template_list.splitlines() if line.strip()]
+    print(f"Found {len(templates)} templates")
+
+    print("Fetching sort order...")
+    order = json.loads(fetch_text(f"{API_BASE}/order"))
+
+    print("Downloading templates...")
+    failures: list[str] = []
+    downloaded = 0
+    pending = templates
+    for attempt in range(1, 4):
+        if attempt > 1:
+            print(f"Retrying {len(pending)} failed templates (attempt {attempt})...")
+        batch_downloaded, batch_failures = download_all(pending)
+        downloaded += batch_downloaded
+        if not batch_failures:
+            failures = []
+            break
+        pending = [entry.split(":", 1)[0] for entry in batch_failures]
+        failures = batch_failures
+
+    (DATA_DIR / "list.txt").write_text("\n".join(templates) + "\n", encoding="utf-8")
+    (DATA_DIR / "order.json").write_text(json.dumps(order, indent=2, sort_keys=True) + "\n", encoding="utf-8")
+    manifest = {
+        "source": API_BASE,
+        "downloaded_at": datetime.now(UTC).isoformat(),
+        "template_count": len(templates),
+    }
+    (DATA_DIR / "manifest.json").write_text(json.dumps(manifest, indent=2) + "\n", encoding="utf-8")
+
+    print(f"Downloaded {len(list(TEMPLATES_DIR.glob('*.gitignore')))}/{len(templates)} templates to {TEMPLATES_DIR}")
+    if failures:
+        print(f"{len(failures)} failures:", file=sys.stderr)
+        for failure in failures[:20]:
+            print(f"  {failure}", file=sys.stderr)
+        if len(failures) > 20:
+            print(f"  ... and {len(failures) - 20} more", file=sys.stderr)
+        return 1
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

gitignorio_cli-0.1.0/src/gitignore_cli/__init__.py

@@ -0,0 +1,3 @@
+"""CLI for creating and updating .gitignore files via gitignore.io."""
+
+__version__ = "0.1.0"

gitignorio_cli-0.1.0/src/gitignore_cli/cli.py

@@ -0,0 +1,193 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+from gitignore_cli.deps import ensure_detection_tools
+from gitignore_cli.detect import detect_languages, detect_os_template, normalize_user_template
+from gitignore_cli.file import GitignoreFile
+from gitignore_cli.hooks import install_global_template, install_repo_hooks
+from gitignore_cli.templates import get_store
+
+app = typer.Typer(
+    no_args_is_help=True,
+    help="Create and update .gitignore files using gitignore.io with automatic language detection.",
+)
+
+
+def _repo_path(path: Optional[Path]) -> Path:
+    return (path or Path.cwd()).resolve()
+
+
+def _gitignore_path(repo_path: Path) -> Path:
+    return repo_path / ".gitignore"
+
+
+@app.command()
+def create(
+    path: Optional[Path] = typer.Option(
+        None,
+        "--path",
+        "-p",
+        help="Repository path (defaults to current directory).",
+    ),
+    no_detect: bool = typer.Option(
+        False,
+        "--no-detect",
+        help="Only add the current operating system template.",
+    ),
+) -> None:
+    """Create a .gitignore with the current OS template and detected languages."""
+    ensure_detection_tools()
+    repo_path = _repo_path(path)
+    gitignore_path = _gitignore_path(repo_path)
+    store = get_store()
+    os_template = detect_os_template()
+
+    if gitignore_path.exists():
+        typer.echo(f".gitignore already exists at {gitignore_path}", err=True)
+        raise typer.Exit(code=1)
+
+    templates = [os_template]
+    if not no_detect:
+        detected = detect_languages(repo_path, store)
+        templates.extend(sorted(detected))
+
+    document = GitignoreFile(path=gitignore_path)
+    document.write(store, store.sort_templates(templates))
+    typer.echo(f"Created {gitignore_path} with templates: {', '.join(store.sort_templates(templates))}")
+
+
+@app.command()
+def update(
+    path: Optional[Path] = typer.Option(
+        None,
+        "--path",
+        "-p",
+        help="Repository path (defaults to current directory).",
+    ),
+) -> None:
+    """Update .gitignore by appending newly detected languages."""
+    ensure_detection_tools()
+    repo_path = _repo_path(path)
+    gitignore_path = _gitignore_path(repo_path)
+    store = get_store()
+    os_template = detect_os_template()
+
+    if not gitignore_path.exists():
+        typer.echo(f"No .gitignore found at {gitignore_path}. Run `gi create` first.", err=True)
+        raise typer.Exit(code=1)
+
+    document = GitignoreFile.load(gitignore_path, store)
+    detected = detect_languages(repo_path, store)
+    content = gitignore_path.read_text(encoding="utf-8")
+
+    to_add: list[str] = []
+    if not document.template_present(store, os_template, content):
+        to_add.append(os_template)
+    for template in sorted(detected):
+        if not document.template_present(store, template, content):
+            to_add.append(template)
+
+    added = document.append_templates(store, to_add)
+    if added:
+        typer.echo(f"Added: {', '.join(added)}")
+        typer.echo(f"Updated {gitignore_path}")
+    else:
+        typer.echo("No changes needed.")
+
+
+@app.command()
+def add(
+    languages: list[str] = typer.Argument(..., help="gitignore.io template names to append."),
+    path: Optional[Path] = typer.Option(
+        None,
+        "--path",
+        "-p",
+        help="Repository path (defaults to current directory).",
+    ),
+) -> None:
+    """Append gitignore templates that are not already present."""
+    repo_path = _repo_path(path)
+    gitignore_path = _gitignore_path(repo_path)
+    store = get_store()
+
+    if not gitignore_path.exists():
+        typer.echo(f"No .gitignore found at {gitignore_path}. Run `gi create` first.", err=True)
+        raise typer.Exit(code=1)
+
+    document = GitignoreFile.load(gitignore_path, store)
+    content = gitignore_path.read_text(encoding="utf-8")
+    to_add: list[str] = []
+    skipped: list[str] = []
+
+    for language in languages:
+        try:
+            template = normalize_user_template(language, store)
+        except ValueError as exc:
+            typer.echo(str(exc), err=True)
+            raise typer.Exit(code=1) from exc
+        if document.template_present(store, template, content):
+            skipped.append(template)
+        else:
+            to_add.append(template)
+
+    added = document.append_templates(store, to_add)
+    if added:
+        typer.echo(f"Added: {', '.join(added)}")
+    if skipped:
+        typer.echo(f"Already present: {', '.join(skipped)}")
+    if not added and skipped:
+        typer.echo("Nothing to do.")
+
+
+@app.command("list")
+def list_templates() -> None:
+    """List available gitignore.io templates."""
+    store = get_store()
+    for template in store.sort_templates(list(store.available)):
+        typer.echo(template)
+
+
+hooks_app = typer.Typer(help="Install git hooks for automatic .gitignore management.")
+app.add_typer(hooks_app, name="hooks")
+
+
+@hooks_app.command("install")
+def hooks_install(
+    path: Optional[Path] = typer.Option(
+        None,
+        "--path",
+        "-p",
+        help="Repository path (defaults to current directory).",
+    ),
+    global_template: bool = typer.Option(
+        False,
+        "--global",
+        help="Also install hooks into the global git init template for new repositories.",
+    ),
+) -> None:
+    """Install post-checkout and pre-push hooks (create or update existing hook scripts)."""
+    repo_path = _repo_path(path)
+    try:
+        results = install_repo_hooks(repo_path)
+    except RuntimeError as exc:
+        typer.echo(str(exc), err=True)
+        raise typer.Exit(code=1) from exc
+
+    for name, status in results:
+        typer.echo(f"{status.capitalize()} {name} hook")
+
+    if global_template:
+        template_dir = install_global_template()
+        typer.echo(f"Configured global init.templateDir at {template_dir}")
+
+
+def main() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    main()