[![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%3Amaster)
# 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](https://raw.githubusercontent.com/amykyta3/git-me-the-url/master/docs/cmd-example.gif?sanitize=true)
## 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)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/amykyta3/git-me-the-url",
"name": "git-me-the-url",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Alex Mykyta",
"author_email": "amykyta3@github.com",
"download_url": "https://files.pythonhosted.org/packages/b6/bb/5f894e0d740b6094f2fc7c3c00f9bf97eeb1778af8f8c470326f6284d716/git-me-the-url-2.1.0.tar.gz",
"platform": null,
"description": "[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/git-me-the-url.svg)](https://pypi.org/project/git-me-the-url)\n[![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%3Amaster)\n\n# Git me the URL!\n\nA python package that translates references in a local git repository into\nshareable URLs for popular Git hosting sites.\n\nCurrently supports:\n* GitHub\n* GitLab\n* Bitbucket\n\nTo add your own URL translator, see this example project: https://github.com/amykyta3/gmtu-plugin-example\n\n## Installing\nInstall from [PyPi](https://pypi.org/project/git-me-the-url) using pip:\n\n python3 -m pip install git-me-the-url\n\n## Command line application\n\nUse it for everyday link sharing with friends:\n\n![cmd-example](https://raw.githubusercontent.com/amykyta3/git-me-the-url/master/docs/cmd-example.gif?sanitize=true)\n\n## Python API\n\nEmbed in your Python application:\n\n```python\nfrom gitmetheurl import GitMeTheURL\n\ngmtu = GitMeTheURL()\nurl = gmtu.get_source_url(\"my_git_repo/my_file.txt\")\nprint(url)\n```",
"bugtrack_url": null,
"license": "",
"summary": "Generate sharable links to your Git source",
"version": "2.1.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6bb5f894e0d740b6094f2fc7c3c00f9bf97eeb1778af8f8c470326f6284d716",
"md5": "90eaeea83fa24e2bc864aea9b1d12f8b",
"sha256": "abf8f4b10de393fe869225e0cd66f40de1864806cd1da2974026b9e91112c038"
},
"downloads": -1,
"filename": "git-me-the-url-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "90eaeea83fa24e2bc864aea9b1d12f8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19768,
"upload_time": "2023-03-13T00:42:30",
"upload_time_iso_8601": "2023-03-13T00:42:30.462610Z",
"url": "https://files.pythonhosted.org/packages/b6/bb/5f894e0d740b6094f2fc7c3c00f9bf97eeb1778af8f8c470326f6284d716/git-me-the-url-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-13 00:42:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "amykyta3",
"github_project": "git-me-the-url",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-me-the-url"
}