Metadata-Version: 2.4
Name: git-me-the-url
Version: 2.2.0
Summary: Generate sharable links to your Git source
Author: Alex Mykyta
License: LGPLv3
Project-URL: Source, https://github.com/amykyta3/git-me-the-url
Project-URL: Tracker, https://github.com/amykyta3/git-me-the-url/issues
Project-URL: Changelog, https://github.com/amykyta3/git-me-the-url/releases
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: gitpython
Dynamic: license-file

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/git-me-the-url.svg)](https://pypi.org/project/git-me-the-url)
[![build](https://github.com/amykyta3/git-me-the-url/actions/workflows/build.yml/badge.svg)](https://github.com/amykyta3/git-me-the-url/actions?query=workflow%3Abuild+branch%3Amain)

# Git me the URL!

A python package that translates references in a local git repository into
shareable URLs for popular Git hosting sites.

Currently supports:
* GitHub
* GitLab
* Bitbucket

To add your own URL translator, see this example project: https://github.com/amykyta3/gmtu-plugin-example

## Installing
Install from [PyPi](https://pypi.org/project/git-me-the-url) using pip:

    python3 -m pip install git-me-the-url

## Command line application

Use it for everyday link sharing with friends:

![cmd-example](docs/cmd-example.gif)

## Python API

Embed in your Python application:

```python
from gitmetheurl import GitMeTheURL

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