Git URL Parse

1.2.2 · active · verified Thu Apr 16

git-url-parse is a Python library designed for robustly parsing Git repository URLs, extracting components such as the host, owner, repository name, and protocol. It supports various Git URL formats including HTTP/S, SSH, and Git protocol. The current version is 1.2.2. While the project repository shows active maintenance with commits, official PyPI releases occur infrequently.

Common errors

```
ModuleNotFoundError: No module named 'giturlparse'
```
cause The package was installed as `git-url-parse`, but an incorrect module name (e.g., `giturlparse` or `git-url-parse`) was used in the import statement.

fix The correct import statement is `from git_url_parse import GitUrlParse`.
```
AttributeError: module 'git_url_parse' has no attribute 'parse'
```
cause The `parse` method is part of the `GitUrlParse` class, not a top-level function in the `git_url_parse` module. You are trying to call it without instantiating the class.

fix First, import the class: `from git_url_parse import GitUrlParse`. Then, create an instance and call the method: `parsed_url = GitUrlParse().parse(url)`.

Warnings

breaking The v1.0.0 release introduced a significant breaking change, transitioning the API to a class-based approach. Older code that relied on direct function calls from the module root will no longer work.
Fix: Migrate your parsing logic to use the `GitUrlParse().parse()` method. Consult the official documentation for the new API.
gotcha The PyPI package name uses hyphens (`git-url-parse`), but the Python module name uses underscores (`git_url_parse`). Attempting to import with hyphens will result in a ModuleNotFoundError.
Fix: Always use `from git_url_parse import GitUrlParse` for importing.
gotcha The main parsing method, `parse()`, must be called on an instance of the `GitUrlParse` class. Directly calling `git_url_parse.parse()` (as a module-level function) will raise an `AttributeError`.
Fix: Instantiate the class first: `parsed_url = GitUrlParse().parse(url)`.
gotcha While the GitHub repository for git-url-parse is actively maintained with recent commits, the official PyPI package (v1.2.2) has not been updated since September 2022. This means recent bug fixes or minor features in the `main` branch may not be available via `pip install`.
Fix: For the very latest features or unreleased bug fixes, consider installing directly from the GitHub repository: `pip install git+https://github.com/retr0h/git-url-parse.git`.

Install

pip install git-url-parse Install stable version

Imports

GitUrlParse
wrong:
```
import git_url_parse
```
correct:
```
from git_url_parse import GitUrlParse
```
The primary parsing functionality is accessed via an instance of the GitUrlParse class.

Quickstart

This quickstart demonstrates how to parse a common HTTPS Git URL and access its extracted components using the GitUrlParse class.

from git_url_parse import GitUrlParse

# Example 1: HTTPS URL
url = "https://github.com/retr0h/git-url-parse.git"
parsed_url = GitUrlParse().parse(url)

print(f"Host: {parsed_url.host}")
print(f"Owner: {parsed_url.owner}")
print(f"Repo: {parsed_url.repo}")
print(f"Protocol: {parsed_url.protocol}")
print(f"Name: {parsed_url.name}")
print(f"Token: {parsed_url.token}") # Empty for public URLs

view raw JSON →