git-me-the-url

What it is and what it does

Git me the URL is a Python library and command-line tool that takes a reference to a file, commit, or branch in a local git repository and generates a shareable URL pointing to that resource on a public git hosting platform. It currently supports GitHub, GitLab, and Bitbucket out of the box, and provides a plugin interface for adding support for other hosting services.

The package is designed for developers who want to quickly share links to code with teammates or in documentation without manually constructing URLs. It works by inspecting the local repository's remote configuration to determine the hosting platform and constructing the appropriate URL format for that platform. The library can be used either as a command-line tool for ad-hoc link generation or embedded in Python applications that need to programmatically generate shareable code links.

Use it for:

• Generate GitHub/GitLab/Bitbucket URLs from local file paths to share in chat or documentation.
• Embed in CI/CD pipelines to automatically create shareable links to build artifacts or test reports.
• Build IDE plugins or editor extensions that add 'share this file' functionality.
• Create issue tracker integrations that link to specific lines of code in pull requests.
• Automate link generation in code review tools or documentation generators.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Converts git repository references (file paths, commits, branches) into shareable URLs for GitHub, GitLab, and Bitbucket, with a plugin system for adding other hosting sites.

Yes, if you need to generate shareable git hosting URLs from local repositories. Install friction is minimal and the library is stable. The LGPLv3 copyleft license is a consideration for proprietary use. The aging maintenance status (no updates in 266 days) is a minor concern but not a blocker for stable functionality; monitor the repository for security issues or breaking changes in your hosting platforms.

Install

git-me-the-url on PyPI

pip install git-me-the-url

uv add git-me-the-url

poetry add git-me-the-url

Installing git-me-the-url

Before you install

Low friction install with a single runtime dependency (gitpython). Last release was recent and the repository is active, though maintenance is aging—no updates in the past 266 days despite the project being marked production-stable.

License in practice

Licensed under LGPLv3 (copyleft), which requires that any modifications you distribute must also be licensed under LGPLv3 and source made available; acceptable for most open-source and internal use but restrictive for proprietary closed-source distribution.

Quickstart

pip install git-me-the-url

from gitmetheurl import GitMeTheURL

gmtu = GitMeTheURL()
url = gmtu.get_source_url("my_git_repo/my_file.txt")
print(url)

Requires a working git installation and a valid local git repository to reference.

Verify before relying

• Whether the plugin system is documented and stable enough for production use.
• Performance characteristics when handling large repositories or many concurrent URL translations.
• Whether the package handles edge cases like detached HEAD states or submodules.

Package facts

Evidence: git_me_the_url-2.2.0-py3-none-any.whl

Tags

More Git packages