git-uff 0.2.0__tar.gz → 0.4.0__tar.gz

{git-uff-0.2.0 → git_uff-0.4.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: git-uff
-Version: 0.2.0
+Version: 0.4.0
 Summary: Prints the forge url for a given file of a Git repository checkout
-Home-page: https://github.com/agateau/git-uff
 License: Apache 2.0
 Author: Aurélien Gâteau
 Author-email: mail@agateau.com
@@ -16,7 +15,13 @@ Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: gitpython (>=3.1.12,<4.0.0)
+Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
+Project-URL: Homepage, https://github.com/agateau/git-uff
 Project-URL: Repository, https://github.com/agateau/git-uff
 Description-Content-Type: text/markdown
 
@@ -52,7 +57,46 @@ $ git uff src/linux/nanonote.desktop -l 10
 https://github.com/agateau/nanonote/blob/master/src/linux/nanonote.desktop#L10
 ```
 
-## But my code is not on GitHub...
+`git-uff` has a few other available options. Here is its `--help` output:
+
+<!-- [[[cog
+import subprocess
+result = subprocess.run(["git-uff", "--help"], capture_output=True, text=True)
+cog.outl("```")
+cog.out(result.stdout)
+cog.outl("```")
+]]]-->
+```
+usage: git-uff [-h] [-b BRANCH] [-p] [-c] [-l LINE] path
+
+Prints the forge URL for a given file or path of a Git repository checkout.
+
+positional arguments:
+  path                  File for which we want the URL
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -b BRANCH, --branch BRANCH
+                        Use branch BRANCH instead of the current one
+  -p, --permalink       Replace the branch in the URL with the commit it
+                        points to
+  -c, --copy            Copy the result to the clipboard
+  -l LINE, --line LINE  Line to point to
+
+New forges can be declared in git configuration. You can do so using
+`git config`, like this:
+
+    git config --global uff.<forge_base_url>.forge <forge>
+
+Where <forge> must be one of: cgit, github, gitlab, sourcehut.
+
+For example to declare that example.com uses GitLab:
+
+    git config --global uff.example.com.forge gitlab
+```
+<!--[[[end]]] -->
+
+## What if my code is not on GitHub?
 
 `git-uff` is not tied to GitHub. It supports GitLab, SourceHut and CGit forges.
 
@@ -64,10 +108,11 @@ For example to declare that example.com uses GitLab:
 
     git config --global uff.example.com.forge gitlab
 
+See the output of `git uff --help` for the valid `<forge>` values.
 
 ## Installation
 
-The recommended solution is to use [pipx][]:
+The recommended method to install `git-uff` is to use [pipx][]:
 
 ```
 pipx install git-uff

{git-uff-0.2.0 → git_uff-0.4.0}/README.md

@@ -30,7 +30,46 @@ $ git uff src/linux/nanonote.desktop -l 10
 https://github.com/agateau/nanonote/blob/master/src/linux/nanonote.desktop#L10
 ```
 
-## But my code is not on GitHub...
+`git-uff` has a few other available options. Here is its `--help` output:
+
+<!-- [[[cog
+import subprocess
+result = subprocess.run(["git-uff", "--help"], capture_output=True, text=True)
+cog.outl("```")
+cog.out(result.stdout)
+cog.outl("```")
+]]]-->
+```
+usage: git-uff [-h] [-b BRANCH] [-p] [-c] [-l LINE] path
+
+Prints the forge URL for a given file or path of a Git repository checkout.
+
+positional arguments:
+  path                  File for which we want the URL
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -b BRANCH, --branch BRANCH
+                        Use branch BRANCH instead of the current one
+  -p, --permalink       Replace the branch in the URL with the commit it
+                        points to
+  -c, --copy            Copy the result to the clipboard
+  -l LINE, --line LINE  Line to point to
+
+New forges can be declared in git configuration. You can do so using
+`git config`, like this:
+
+    git config --global uff.<forge_base_url>.forge <forge>
+
+Where <forge> must be one of: cgit, github, gitlab, sourcehut.
+
+For example to declare that example.com uses GitLab:
+
+    git config --global uff.example.com.forge gitlab
+```
+<!--[[[end]]] -->
+
+## What if my code is not on GitHub?
 
 `git-uff` is not tied to GitHub. It supports GitLab, SourceHut and CGit forges.
 
@@ -42,10 +81,11 @@ For example to declare that example.com uses GitLab:
 
     git config --global uff.example.com.forge gitlab
 
+See the output of `git uff --help` for the valid `<forge>` values.
 
 ## Installation
 
-The recommended solution is to use [pipx][]:
+The recommended method to install `git-uff` is to use [pipx][]:
 
 ```
 pipx install git-uff

{git-uff-0.2.0 → git_uff-0.4.0}/git_uff/converters.py

@@ -1,13 +1,28 @@
 # Copyright 2021 Aurélien Gâteau <mail@agateau.com>
 # SPDX-License-Identifier: Apache-2.0
 import re
+import sys
 
 from typing import Dict, Type, Optional
 
+from urllib.error import HTTPError
 from urllib.parse import quote_plus
+from urllib.request import Request, urlopen
 from pathlib import Path
 
 
+BUG_URL = "https://github.com/agateau/git-uff/issues/new"
+
+
+def check_existence(url: str) -> bool:
+    req = Request(url, method='HEAD')
+    try:
+        with urlopen(req) as f:
+            return True
+    except HTTPError:
+        return False
+
+
 class Converter:
     """A Converter turns a local path into its matching forge URL.
 
@@ -41,6 +56,13 @@ class Converter:
         url = self.URL_TEMPLATE.format(**dct)
         if line is not None:
             url += self.LINE_SUFFIX.format(line=line)
+
+        if not check_existence(url):
+            print(
+                f"URL {url} does not exist, maybe you have not pushed your changes yet?\n"
+                f"If you think this is a bug in git-uff, please report it on {BUG_URL}.",
+                file=sys.stderr)
+            sys.exit(1)
         return url
 
     def get_project(self, remote_url: str) -> str:

{git-uff-0.2.0 → git_uff-0.4.0}/git_uff/main.py

@@ -10,6 +10,7 @@ import sys
 from pathlib import Path
 from typing import Tuple, List
 
+import pyperclip
 from git import Repo
 
 from git_uff.config import load_config
@@ -69,6 +70,14 @@ def main() -> None:
     )
 
     parser.add_argument("path", help="File for which we want the URL")
+    parser.add_argument("-b", "--branch",
+                        help="Use branch BRANCH instead of the current one",
+                        metavar="BRANCH")
+    parser.add_argument("-p", "--permalink", action="store_true",
+                        help="Replace the branch in the URL with the commit"
+                        " it points to")
+    parser.add_argument("-c", "--copy", action="store_true",
+                        help="Copy the result to the clipboard")
     parser.add_argument("-l", "--line", type=int, help="Line to point to")
 
     args = parser.parse_args()
@@ -84,10 +93,17 @@ def main() -> None:
         repo = Repo(repo_root)
         converters = load_config(repo)
         converter, remote_url = find_converter(converters, repo)
-        url = converter.run(remote_url, repo.active_branch.name,
+        if args.branch:
+            branch = args.branch
+        else:
+            branch = repo.active_branch.name
+        if args.permalink:
+            branch = repo.rev_parse(branch).hexsha
+        url = converter.run(remote_url, branch,
                             path.relative_to(repo_root), args.line)
-
         print(url)
+        if args.copy:
+            pyperclip.copy(url)
     except ToolError as e:
         print(e)
         sys.exit(1)

{git-uff-0.2.0 → git_uff-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "git-uff"
-version = "0.2.0"
+version = "0.4.0"
 description = "Prints the forge url for a given file of a Git repository checkout"
 readme = "README.md"
 authors = ["Aurélien Gâteau <mail@agateau.com>"]
@@ -16,6 +16,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.6"
 gitpython = "^3.1.12"
+pyperclip = "^1.8.2"
 
 [tool.poetry.dev-dependencies]
 

git-uff-0.2.0/setup.py

@@ -1,34 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['git_uff']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['gitpython>=3.1.12,<4.0.0']
-
-entry_points = \
-{'console_scripts': ['git-uff = git_uff.main:main']}
-
-setup_kwargs = {
-    'name': 'git-uff',
-    'version': '0.2.0',
-    'description': 'Prints the forge url for a given file of a Git repository checkout',
-    'long_description': '# git-uff\n\nPrints the forge URL for a given file of a Git repository checkout.\n\n## Intro\n\nHave you ever been discussing with colleagues over IRC/Slack/Matrix/whatever about source code and found yourself needing to point them to a particular file in a git repository?\n\nThis is tedious to do.\n\nOne solution is to tell them the path in their checkout, hoping they are on the same branch as you.\n\nAnother solution is to point your browser to the forge hosting your git repository, select the right branch, navigate the file hierarchy, find your file and copy the file URL.\n\nA better (in my opinion 😉) solution is to use `git-uff`. This tool adds an `uff` (short for "URL for file") git sub-command, which takes the path to a file in your repository checkout and prints the matching forge URL.\n\nFor example to print the URL of the `src/linux/nanonote.desktop` file from my [Nanonote][] project:\n\n```\n$ git uff src/linux/nanonote.desktop\nhttps://github.com/agateau/nanonote/blob/master/src/linux/nanonote.desktop\n```\n\n[Nanonote]: https://github.com/agateau/nanonote\n\nYou can also point them to a specific line with the `-l` argument:\n\n```\n$ git uff src/linux/nanonote.desktop -l 10\nhttps://github.com/agateau/nanonote/blob/master/src/linux/nanonote.desktop#L10\n```\n\n## But my code is not on GitHub...\n\n`git-uff` is not tied to GitHub. It supports GitLab, SourceHut and CGit forges.\n\nTo declare a new forge, add it to your git configuration with:\n\n    git config --global uff.<forge_base_url>.forge <forge>\n\nFor example to declare that example.com uses GitLab:\n\n    git config --global uff.example.com.forge gitlab\n\n\n## Installation\n\nThe recommended solution is to use [pipx][]:\n\n```\npipx install git-uff\n```\n\n[pipx]: https://github.com/pipxproject/pipx\n\nBut you can also install it with `pip`:\n\n```\npip install --user git-uff\n```\n\n## License\n\nApache 2.0\n',
-    'author': 'Aurélien Gâteau',
-    'author_email': 'mail@agateau.com',
-    'maintainer': None,
-    'maintainer_email': None,
-    'url': 'https://github.com/agateau/git-uff',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'entry_points': entry_points,
-    'python_requires': '>=3.6,<4.0',
-}
-
-
-setup(**setup_kwargs)