| Name | git-web-url JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | https://github.com/MacHu-GWU/git_web_url-project |
| Summary | A CLI tool and also a Python library can print the url of a local file in a git repo so you can one-click to open it in web browser. |
| upload_time | 2023-10-03 15:54:08 |
| maintainer | Sanhe Hu |
| docs_url | None |
| author | Sanhe Hu |
| requires_python | |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
.. .. image:: https://readthedocs.org/projects/git-web-url/badge/?version=latest
:target: https://git-web-url.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://github.com/MacHu-GWU/git_web_url-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/git_web_url-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/git_web_url-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/git_web_url-project
.. image:: https://img.shields.io/pypi/v/git-web-url.svg
:target: https://pypi.python.org/pypi/git-web-url
.. image:: https://img.shields.io/pypi/l/git-web-url.svg
:target: https://pypi.python.org/pypi/git-web-url
.. image:: https://img.shields.io/pypi/pyversions/git-web-url.svg
:target: https://pypi.python.org/pypi/git-web-url
.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
:target: https://github.com/MacHu-GWU/git_web_url-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/git_web_url-project
------
.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://git-web-url.readthedocs.io/en/latest/
.. .. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://git-web-url.readthedocs.io/en/latest/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/git_web_url-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/git_web_url-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/git_web_url-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/git-web-url#files
Welcome to ``git_web_url`` Documentation
==============================================================================
``git_web_url`` is a CLI tool and also a Python library can print the url of a local file in a git repo so you can one-click to open it in web browser.
Currently it supports:
- GitHub
- GitHub Enterprise
- GitLab
- GitLab Enterprise
- BitBucket
- BitBucket Enterprise
- AWS CodeCommit
**Usage Example**
1. **Auto-discover the git repo**:
cd into your git repo directory, or any folder inside, then run ``gwu``, it prints the url for the current branch and the current directory:
.. code-block:: bash
$ gwu # or gitweburl
https://github.com/your_account/your_repo/tree/your_branch/path/to/current_directory
2. **Explicitly specify the file or folder**:
copy the absolute path of the file or folder in your local git repo, then run ``gwu ${absolute_path_here}``:
.. code-block:: bash
$ gwu /Users/myusername/GitHub/your_repo/path/to/your_file
https://github.com/your_account/your_repo/tree/your_branch/path/to/current_directory
.. _install:
Install
------------------------------------------------------------------------------
``git_web_url`` is released on PyPI, so all you need is to:
.. code-block:: console
$ pip install git-web-url
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade git-web-url
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/git_web_url-project",
"name": "git-web-url",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "",
"maintainer_email": "husanhe@gmail.com",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5e/27/7e945069f5c6f79e67b658e79275e7d5cee3a0d7c6c0f54919a0b71d97ad/git_web_url-0.1.3.tar.gz",
"platform": "Windows",
"description": "\n.. .. image:: https://readthedocs.org/projects/git-web-url/badge/?version=latest\n :target: https://git-web-url.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/git_web_url-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/git_web_url-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/git_web_url-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/git_web_url-project\n\n.. image:: https://img.shields.io/pypi/v/git-web-url.svg\n :target: https://pypi.python.org/pypi/git-web-url\n\n.. image:: https://img.shields.io/pypi/l/git-web-url.svg\n :target: https://pypi.python.org/pypi/git-web-url\n\n.. image:: https://img.shields.io/pypi/pyversions/git-web-url.svg\n :target: https://pypi.python.org/pypi/git-web-url\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/git_web_url-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/git_web_url-project\n\n------\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://git-web-url.readthedocs.io/en/latest/\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://git-web-url.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/git_web_url-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/git_web_url-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/git_web_url-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/git-web-url#files\n\n\nWelcome to ``git_web_url`` Documentation\n==============================================================================\n``git_web_url`` is a CLI tool and also a Python library can print the url of a local file in a git repo so you can one-click to open it in web browser.\n\nCurrently it supports:\n\n- GitHub\n- GitHub Enterprise\n- GitLab\n- GitLab Enterprise\n- BitBucket\n- BitBucket Enterprise\n- AWS CodeCommit\n\n**Usage Example**\n\n1. **Auto-discover the git repo**:\n\ncd into your git repo directory, or any folder inside, then run ``gwu``, it prints the url for the current branch and the current directory:\n\n.. code-block:: bash\n\n $ gwu # or gitweburl\n https://github.com/your_account/your_repo/tree/your_branch/path/to/current_directory\n\n\n2. **Explicitly specify the file or folder**:\n\ncopy the absolute path of the file or folder in your local git repo, then run ``gwu ${absolute_path_here}``:\n\n.. code-block:: bash\n\n $ gwu /Users/myusername/GitHub/your_repo/path/to/your_file\n https://github.com/your_account/your_repo/tree/your_branch/path/to/current_directory\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``git_web_url`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n $ pip install git-web-url\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade git-web-url\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI tool and also a Python library can print the url of a local file in a git repo so you can one-click to open it in web browser.",
"version": "0.1.3",
"project_urls": {
"Download": "https://pypi.python.org/pypi/git_web_url/0.1.3#downloads",
"Homepage": "https://github.com/MacHu-GWU/git_web_url-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08237403a9b49291a2f0e1468df0c17a8bcd0cc8dadce07b2feae125336595bb",
"md5": "0ae5327b4a674e8b62b8d04a2ff8d3e7",
"sha256": "bb9f9070ba8a9efd0caf04ba2e09a0e9f9640feed724529295e74234899b85cb"
},
"downloads": -1,
"filename": "git_web_url-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ae5327b4a674e8b62b8d04a2ff8d3e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15351,
"upload_time": "2023-10-03T15:54:06",
"upload_time_iso_8601": "2023-10-03T15:54:06.831033Z",
"url": "https://files.pythonhosted.org/packages/08/23/7403a9b49291a2f0e1468df0c17a8bcd0cc8dadce07b2feae125336595bb/git_web_url-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e277e945069f5c6f79e67b658e79275e7d5cee3a0d7c6c0f54919a0b71d97ad",
"md5": "cfb2ee584ae607a6fdb895b1dc6dbb10",
"sha256": "d31d4eb022d511445058e4630122a5ed40ec74237e5d4ffe995858038cf533b4"
},
"downloads": -1,
"filename": "git_web_url-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "cfb2ee584ae607a6fdb895b1dc6dbb10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16599,
"upload_time": "2023-10-03T15:54:08",
"upload_time_iso_8601": "2023-10-03T15:54:08.645446Z",
"url": "https://files.pythonhosted.org/packages/5e/27/7e945069f5c6f79e67b658e79275e7d5cee3a0d7c6c0f54919a0b71d97ad/git_web_url-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-03 15:54:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "git_web_url-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "git-web-url"
}
