gitlane 0.1.0__tar.gz

gitlane-0.1.0/LICENSE

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

gitlane-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: gitlane
+Version: 0.1.0
+Summary: A free, open-source Git client that runs in your browser.
+Author: Gustavo Leite
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/gustavojoseleite/gitlane
+Project-URL: Issues, https://github.com/gustavojoseleite/gitlane/issues
+Project-URL: Changelog, https://github.com/gustavojoseleite/gitlane/blob/main/CHANGELOG.md
+Keywords: git,git-client,gui,commit-graph,browser,version-control
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn>=0.29
+Requires-Dist: GitPython>=3.1.40
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Provides-Extra: e2e
+Requires-Dist: playwright>=1.40; extra == "e2e"
+Dynamic: license-file
+
+# gitlane
+
+**A free, open-source Git client that runs in your browser.** Commit, push, pull, see the
+commit graph, manage branches and stashes — in a clean local web app, with one command.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gustavojoseleite/gitlane/main/docs/screenshots/main-dark.png">
+  <img alt="gitlane showing a repository: changed files on the left, the commit graph in the middle, a commit with its diff on the right" src="https://raw.githubusercontent.com/gustavojoseleite/gitlane/main/docs/screenshots/main-light.png">
+</picture>
+
+## Features
+
+- **Changes** — see changed, staged and untracked files; stage, unstage or discard whole files; commit with a summary and description
+- **Diffs** — for your working files and any commit, with **before/after previews for images**
+- **Commit graph** — all branches with colored lanes, branch/tag labels and your stashes; fast on repositories with tens of thousands of commits
+- **Right-click menus** — checkout, create a branch, cherry-pick, revert, reset (soft / mixed / hard), merge, delete branches (also on the remote)
+- **Sync** — fetch, pull, push, and force push that always uses `--force-with-lease`
+- **Stash** — save (including untracked files), apply, pop, drop, and look inside a stash
+- **Merge conflicts** — see the conflicted files, then *abort* or *mark resolved and commit*
+- **Tabs** — several repositories at once; recent repos and a folder browser to open more
+- **Safe by default** — dangerous actions ask first; runs only on your computer (see [Security](#security))
+- Light and dark theme (follows your system)
+
+![Right-click menu on a commit](https://raw.githubusercontent.com/gustavojoseleite/gitlane/main/docs/screenshots/menu.png)
+
+## Install
+
+You need **Python 3.10+** and **Git 2.23+** (most systems already have both).
+
+The recommended way is [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/). They
+install gitlane in its own environment, so it never conflicts with your other Python projects:
+
+```bash
+pipx install gitlane
+# or
+uv tool install gitlane
+```
+
+Just want to try it, without installing anything? With uv:
+
+```bash
+uvx gitlane
+```
+
+<details>
+<summary>Don't have pipx or uv yet?</summary>
+
+| System | Install pipx |
+|---|---|
+| Ubuntu / Debian | `sudo apt install pipx && pipx ensurepath` |
+| Fedora | `sudo dnf install pipx && pipx ensurepath` |
+| macOS | `brew install pipx && pipx ensurepath` |
+| Windows | `py -m pip install --user pipx` then `py -m pipx ensurepath` |
+
+Open a new terminal afterwards so the `gitlane` command is found.
+</details>
+
+<details>
+<summary>Install the latest development version from GitHub</summary>
+
+```bash
+pipx install git+https://github.com/gustavojoseleite/gitlane
+```
+</details>
+
+**Update:** `pipx upgrade gitlane` (or `uv tool upgrade gitlane`)
+**Uninstall:** `pipx uninstall gitlane` (or `uv tool uninstall gitlane`)
+
+## Usage
+
+```bash
+gitlane                      # inside a repository: open it
+gitlane ~/dev/my-project     # open a specific repository
+gitlane                      # anywhere else: reopen your tabs, or pick a repository
+```
+
+gitlane starts a small server on your computer and opens it in your browser. Keep the terminal
+open while you use it; press **Ctrl+C** to stop. Use **+** next to the tabs to open more
+repositories. Open tabs and recent repos are remembered.
+
+| Option | What it does |
+|---|---|
+| `--port 8000` | use a fixed port (default: a free one) |
+| `--no-browser` | only print the link, don't open the browser |
+| `--install-launcher` | add gitlane to your app menu (Linux) |
+| `--remove-launcher` | remove it from the app menu |
+| `--version` | show the version |
+
+**Keyboard:** `↑` `↓` move through commits · `Enter` open · `R` refresh · `Ctrl+Enter` commit ·
+`Esc` close menus and dialogs. Drag the dividers between panels to resize them (double-click to reset).
+
+### Push and pull: logging in
+
+gitlane uses **your own Git setup** and never asks for or stores passwords. If `git push` works in
+your terminal without typing a password, it works in gitlane too.
+
+- **SSH remotes** (`git@github.com:you/repo.git`) — recommended. Set up an SSH key once:
+  [GitHub guide](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+- **HTTPS remotes** (`https://github.com/you/repo.git`) — need a credential helper, for example
+  `gh auth setup-git` ([GitHub CLI](https://cli.github.com/)) or
+  [Git Credential Manager](https://github.com/git-ecosystem/git-credential-manager).
+  Or switch the remote to SSH: `git remote set-url origin git@github.com:you/repo.git`
+
+## Security
+
+gitlane is a local app, but a web server on your computer still needs care:
+
+- It listens **only on `127.0.0.1`** — other computers can't reach it.
+- Every start creates a **secret token** in the link; without it every request is refused.
+  The token is then kept in a cookie that other websites can't use.
+- It rejects requests from other websites (Origin and Host checks, which also block DNS rebinding).
+- Changes are only made with `POST` requests; dangerous actions ask you first.
+- Image previews are served so that an SVG from a repository can never run scripts.
+
+Found a security problem? Please open an issue without the details first, and we'll find a private way to talk.
+
+## Contributing
+
+Bug reports, ideas and pull requests are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for how to
+set up the project, run the tests and send a change.
+
+## License
+
+[MIT](LICENSE) © 2026 Gustavo Leite — free to use, change and share, including for commercial work.
+
+gitlane includes [htmx](https://htmx.org/) (Zero-Clause BSD license).

gitlane-0.1.0/README.md

@@ -0,0 +1,126 @@
+# gitlane
+
+**A free, open-source Git client that runs in your browser.** Commit, push, pull, see the
+commit graph, manage branches and stashes — in a clean local web app, with one command.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gustavojoseleite/gitlane/main/docs/screenshots/main-dark.png">
+  <img alt="gitlane showing a repository: changed files on the left, the commit graph in the middle, a commit with its diff on the right" src="https://raw.githubusercontent.com/gustavojoseleite/gitlane/main/docs/screenshots/main-light.png">
+</picture>
+
+## Features
+
+- **Changes** — see changed, staged and untracked files; stage, unstage or discard whole files; commit with a summary and description
+- **Diffs** — for your working files and any commit, with **before/after previews for images**
+- **Commit graph** — all branches with colored lanes, branch/tag labels and your stashes; fast on repositories with tens of thousands of commits
+- **Right-click menus** — checkout, create a branch, cherry-pick, revert, reset (soft / mixed / hard), merge, delete branches (also on the remote)
+- **Sync** — fetch, pull, push, and force push that always uses `--force-with-lease`
+- **Stash** — save (including untracked files), apply, pop, drop, and look inside a stash
+- **Merge conflicts** — see the conflicted files, then *abort* or *mark resolved and commit*
+- **Tabs** — several repositories at once; recent repos and a folder browser to open more
+- **Safe by default** — dangerous actions ask first; runs only on your computer (see [Security](#security))
+- Light and dark theme (follows your system)
+
+![Right-click menu on a commit](https://raw.githubusercontent.com/gustavojoseleite/gitlane/main/docs/screenshots/menu.png)
+
+## Install
+
+You need **Python 3.10+** and **Git 2.23+** (most systems already have both).
+
+The recommended way is [pipx](https://pipx.pypa.io/) or [uv](https://docs.astral.sh/uv/). They
+install gitlane in its own environment, so it never conflicts with your other Python projects:
+
+```bash
+pipx install gitlane
+# or
+uv tool install gitlane
+```
+
+Just want to try it, without installing anything? With uv:
+
+```bash
+uvx gitlane
+```
+
+<details>
+<summary>Don't have pipx or uv yet?</summary>
+
+| System | Install pipx |
+|---|---|
+| Ubuntu / Debian | `sudo apt install pipx && pipx ensurepath` |
+| Fedora | `sudo dnf install pipx && pipx ensurepath` |
+| macOS | `brew install pipx && pipx ensurepath` |
+| Windows | `py -m pip install --user pipx` then `py -m pipx ensurepath` |
+
+Open a new terminal afterwards so the `gitlane` command is found.
+</details>
+
+<details>
+<summary>Install the latest development version from GitHub</summary>
+
+```bash
+pipx install git+https://github.com/gustavojoseleite/gitlane
+```
+</details>
+
+**Update:** `pipx upgrade gitlane` (or `uv tool upgrade gitlane`)
+**Uninstall:** `pipx uninstall gitlane` (or `uv tool uninstall gitlane`)
+
+## Usage
+
+```bash
+gitlane                      # inside a repository: open it
+gitlane ~/dev/my-project     # open a specific repository
+gitlane                      # anywhere else: reopen your tabs, or pick a repository
+```
+
+gitlane starts a small server on your computer and opens it in your browser. Keep the terminal
+open while you use it; press **Ctrl+C** to stop. Use **+** next to the tabs to open more
+repositories. Open tabs and recent repos are remembered.
+
+| Option | What it does |
+|---|---|
+| `--port 8000` | use a fixed port (default: a free one) |
+| `--no-browser` | only print the link, don't open the browser |
+| `--install-launcher` | add gitlane to your app menu (Linux) |
+| `--remove-launcher` | remove it from the app menu |
+| `--version` | show the version |
+
+**Keyboard:** `↑` `↓` move through commits · `Enter` open · `R` refresh · `Ctrl+Enter` commit ·
+`Esc` close menus and dialogs. Drag the dividers between panels to resize them (double-click to reset).
+
+### Push and pull: logging in
+
+gitlane uses **your own Git setup** and never asks for or stores passwords. If `git push` works in
+your terminal without typing a password, it works in gitlane too.
+
+- **SSH remotes** (`git@github.com:you/repo.git`) — recommended. Set up an SSH key once:
+  [GitHub guide](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
+- **HTTPS remotes** (`https://github.com/you/repo.git`) — need a credential helper, for example
+  `gh auth setup-git` ([GitHub CLI](https://cli.github.com/)) or
+  [Git Credential Manager](https://github.com/git-ecosystem/git-credential-manager).
+  Or switch the remote to SSH: `git remote set-url origin git@github.com:you/repo.git`
+
+## Security
+
+gitlane is a local app, but a web server on your computer still needs care:
+
+- It listens **only on `127.0.0.1`** — other computers can't reach it.
+- Every start creates a **secret token** in the link; without it every request is refused.
+  The token is then kept in a cookie that other websites can't use.
+- It rejects requests from other websites (Origin and Host checks, which also block DNS rebinding).
+- Changes are only made with `POST` requests; dangerous actions ask you first.
+- Image previews are served so that an SVG from a repository can never run scripts.
+
+Found a security problem? Please open an issue without the details first, and we'll find a private way to talk.
+
+## Contributing
+
+Bug reports, ideas and pull requests are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for how to
+set up the project, run the tests and send a change.
+
+## License
+
+[MIT](LICENSE) © 2026 Gustavo Leite — free to use, change and share, including for commercial work.
+
+gitlane includes [htmx](https://htmx.org/) (Zero-Clause BSD license).

gitlane-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "gitlane"
+version = "0.1.0"
+description = "A free, open-source Git client that runs in your browser."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "Gustavo Leite" }]
+keywords = ["git", "git-client", "gui", "commit-graph", "browser", "version-control"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+dependencies = [
+    "fastapi>=0.110",
+    "uvicorn>=0.29",
+    "GitPython>=3.1.40",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "httpx>=0.27"]
+# Browser tests (tests/test_e2e.py) use your installed Chrome; skipped if missing.
+e2e = ["playwright>=1.40"]
+
+[project.urls]
+Homepage = "https://github.com/gustavojoseleite/gitlane"
+Issues = "https://github.com/gustavojoseleite/gitlane/issues"
+Changelog = "https://github.com/gustavojoseleite/gitlane/blob/main/CHANGELOG.md"
+
+[project.scripts]
+gitlane = "gitlane.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+gitlane = ["static/*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

gitlane-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gitlane-0.1.0/src/gitlane/__init__.py

@@ -0,0 +1,3 @@
+"""gitlane: a free, open-source Git client that runs in your browser."""
+
+__version__ = "0.1.0"

gitlane-0.1.0/src/gitlane/__main__.py

@@ -0,0 +1,7 @@
+"""Allow ``python -m gitlane`` (used by the app-menu launcher)."""
+
+import sys
+
+from .cli import main
+
+sys.exit(main())

gitlane-0.1.0/src/gitlane/blobs.py

@@ -0,0 +1,77 @@
+"""Reading file contents at a given version, used for image previews."""
+
+from __future__ import annotations
+
+from pathlib import Path, PurePosixPath
+
+import git
+
+from .git_ops import GitError, check_paths
+from .graph import resolve_commit
+
+MAX_BLOB_BYTES = 20 * 1024 * 1024
+
+IMAGE_TYPES = {
+    ".png": "image/png",
+    ".jpg": "image/jpeg",
+    ".jpeg": "image/jpeg",
+    ".gif": "image/gif",
+    ".webp": "image/webp",
+    ".avif": "image/avif",
+    ".bmp": "image/bmp",
+    ".ico": "image/x-icon",
+    ".svg": "image/svg+xml",
+}
+
+# Special revisions besides commit ids.
+WORKTREE = "WORKTREE"  # the file on disk
+INDEX = "INDEX"  # the staged version
+HEAD = "HEAD"  # the last commit
+
+
+def image_type(path: str) -> str | None:
+    return IMAGE_TYPES.get(PurePosixPath(path).suffix.lower())
+
+
+def _spec(repo: git.Repo, rev: str, path: str) -> str:
+    if rev == INDEX:
+        return f":0:{path}"
+    if rev == HEAD:
+        return f"HEAD:{path}"
+    return f"{resolve_commit(repo, rev)}:{path}"
+
+
+def _worktree_file(repo: git.Repo, path: str) -> Path | None:
+    root = Path(repo.working_tree_dir).resolve()
+    f = (root / path).resolve()
+    if not f.is_relative_to(root) or not f.is_file():  # also blocks symlinks pointing outside
+        return None
+    return f
+
+
+def blob_exists(repo: git.Repo, rev: str, path: str) -> bool:
+    (path,) = check_paths([path])
+    if rev == WORKTREE:
+        return _worktree_file(repo, path) is not None
+    code, _, _ = repo.git.cat_file("-e", _spec(repo, rev, path),
+                                   with_extended_output=True, with_exceptions=False)
+    return code == 0
+
+
+def read_blob(repo: git.Repo, rev: str, path: str) -> bytes | None:
+    """Contents of ``path`` at ``rev``; None if the file does not exist there."""
+    (path,) = check_paths([path])
+    if rev == WORKTREE:
+        f = _worktree_file(repo, path)
+        if f is None:
+            return None
+        if f.stat().st_size > MAX_BLOB_BYTES:
+            raise GitError("File is too large to preview.")
+        return f.read_bytes()
+    spec = _spec(repo, rev, path)
+    code, size, _ = repo.git.cat_file("-s", spec, with_extended_output=True, with_exceptions=False)
+    if code != 0:
+        return None
+    if int(size) > MAX_BLOB_BYTES:
+        raise GitError("File is too large to preview.")
+    return repo.git.cat_file("blob", spec, stdout_as_string=False, strip_newline_in_stdout=False)