git-gerrit 2.1.0__tar.gz → 3.2.0__tar.gz

{git_gerrit-2.1.0/git_gerrit.egg-info → git_gerrit-3.2.0}/PKG-INFO

@@ -1,22 +1,29 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: git_gerrit
-Version: 2.1.0
+Version: 3.2.0
 Summary: Gerrit review system command line tools.
 Home-page: https://github.com/meffie/git-gerrit
 Author: Michael Meffie
 Author-email: mmeffie@sinenomine.net
-License: BSD
+License: BSD-2-Clause
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: POSIX
-Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development
 License-File: LICENSE.txt
 Requires-Dist: sh
 Requires-Dist: pygerrit2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 git-gerrit
 ==========
@@ -27,12 +34,12 @@ with the **pygerrit2** package to access the Gerrit REST API.
 
 .. _Gerrit code review system: https://www.gerritcodereview.com/
 
-**git-gerrit** is compatible with Python 2 and Python 3.
+**git-gerrit** is requires Python 3.9 or later.
 
 Commands
 ========
 
-.. code-block:: console
+**git-gerrit** commands::
 
     git gerrit-checkout          Fetch then checkout by gerrit number.
     git gerrit-cherry-pick       Cherry pick from upstream branch by gerrit number to make a new gerrit.
@@ -40,25 +47,42 @@ Commands
     git gerrit-help              List commands.
     git gerrit-install-hooks     Install git hooks to create gerrit change-ids.
     git gerrit-log               Show oneline log with gerrit numbers.
+    git gerrit-number            Show info for a gerrit change number.
     git gerrit-query             Search gerrit.
+    git gerrit-sync              Fetch all changes and update the local database.
     git gerrit-update            Update gerrits matching search terms.
-    git gerrit-unpicked          Find gerrit numbers on upstream branch not cherry picked.
     git gerrit-version           Print version and exit.
 
 Installation
 ============
 
 .. _pipx: https://pipx.pypa.io/stable/
+.. _uv: https://github.com/astral-sh/uv
+
+The recommended way to install **git-gerrit** is with `uv`_ or `pipx`_.
+
+To install with ``uv``, run the following as a regular user:
+
+.. code-block:: console
+
+    uv tool install git-gerrit
+    uv tool update-shell
+
+The ``uv tool update-shell`` command adds the installed commands to your
+shell's PATH.  Restart your shell after running ``update-shell``.
 
-Install with `pipx`_::
+To install with ``pipx_``, run the following as a regular user:
 
-    $ pipx install git-gerrit
+.. code-block:: console
 
-Be sure your ``PATH`` has been updated to run **pipx** installed commands::
+    pipx install git-gerrit
+    pipx ensurepath
 
-    $ pipx ensurepath
+The ``pipx ensurepath`` command adds the installed commands to your shell's
+PATH.  Restart you shell after running ``ensurepath``.
 
-If **pipx** is not available, then install in a project local virtualenv::
+Alternatively, you can install **git-gerrit** directly into a local virtual
+environment with ``pip``::
 
     $ cd <my-project-directory>
     $ python3 -m venv .venv
@@ -66,7 +90,6 @@ If **pipx** is not available, then install in a project local virtualenv::
     (.venv) $ pip install -U pip setuptools
     (.venv) $ pip install git-gerrit
 
-
 Setup
 =====
 
@@ -93,6 +116,16 @@ Setup a local OpenAFS git repo::
     $ git config --local gerrit.project openafs
     $ git gerrit-install-hooks
 
+Fetch all of the change commits from the upstream gerrit system to your local
+repository and create the local sqlite database. This is a heavy weight operation
+and is only needed for **git gerrit-log** and **git gerrit-number**::
+
+    $ git gerrit-sync
+    ✔ Fetching changes from https://gerrit.example.com/example
+    ✔ Updating local database
+    ✔ Scanning commit messages
+    Done.
+
 Find open gerrits on the master branch::
 
     $ git gerrit-query is:open branch:master
@@ -124,7 +157,7 @@ Find gerrits with subjects containing the term 'debuginfo'::
 
 Find the branch names of gerrits with the subject containing the term 'debuginfo'::
 
-    $ git gerrit-query --format='{branch:>20s} {_number} {subject}' debuginfo
+    $ git gerrit-query --format='{branch:>20s} {number} {subject}' debuginfo
                   master 13030 redhat: Make separate debuginfo for kmods work with recent rpm
     openafs-stable-1_6_x 13029 redhat: Create unique debuginfo packages for kmods
     openafs-stable-1_6_x 12818 redhat: separate debuginfo package for kmod rpm
@@ -151,18 +184,18 @@ Checkout a gerrit by number::
 
 Cherry-pick a gerrit onto the current branch::
 
-    $ git gerrit-fetch --no-branch 13001 && git cherry-pick FETCH_HEAD
+    $ git gerrit-fetch 13001 && git cherry-pick FETCH_HEAD
 
 Show gerrit numbers in the checked out branch in the local git repo::
 
-    $ git gerrit-log
+    $ git gerrit-log -n3
     12958 f47cb2d Suppress statement not reached warnings under Solaris Studio
     12957 306f0f3 afs: squash empty declaration warning
     12955 e006609 libafs: git ignore build artifacts on Solaris
 
 Show gerrit numbers by a revision in the local git repo::
 
-    $ git gerrit-log openafs-stable-1_8_0
+    $ git gerrit-log -n3 openafs-stable-1_8_0
     12953 a08327f Update NEWS for 1.8.0 final release
     12938 acb0e84 afs_pioctl: avoid -Wpointer-sign
     12950 b73863b LINUX: fix RedHat 7.5 ENOTDIR issues
@@ -176,20 +209,11 @@ Show gerrit numbers by a range of revisions in the local git repo::
 
 Show just the gerrit numbers and subjects in the local git repo::
 
-    $ git gerrit-log --format='{number}: {subject}'
+    $ git gerrit-log -n3 --format='{number}: {subject}'
     12958: Suppress statement not reached warnings under Solaris Studio
     12957: afs: squash empty declaration warning
     12955: libafs: git ignore build artifacts on Solaris
 
-Show the commits on the master branch which have not been cherry-picked on to
-the stable branch. (Gerrits may already exists for them.)::
-
-    $ git gerrit-unpicked -u origin/master origin/openafs-stable-1_8_x
-    13656 4eeed830fa31b7b8b5487ba619acbc8d30642aaa afscp: Link against opr/roken/hcrypto
-    13659 f5f59cd8d336b153e2b762bb7afd16e6ab1b1ee2 util: serverLog using memory after free
-    13665 1210a8d6d96db2d84595d35ef81ec5d176de05e8 LINUX: Run the 'sparse' checker if available
-    ...
-
 Add reviewers to the **foobar** topic::
 
     $ git gerrit-update --add-reviewer="ty@example.com" branch:master is:open topic:foobar

{git_gerrit-2.1.0 → git_gerrit-3.2.0}/README.rst

@@ -7,12 +7,12 @@ with the **pygerrit2** package to access the Gerrit REST API.
 
 .. _Gerrit code review system: https://www.gerritcodereview.com/
 
-**git-gerrit** is compatible with Python 2 and Python 3.
+**git-gerrit** is requires Python 3.9 or later.
 
 Commands
 ========
 
-.. code-block:: console
+**git-gerrit** commands::
 
     git gerrit-checkout          Fetch then checkout by gerrit number.
     git gerrit-cherry-pick       Cherry pick from upstream branch by gerrit number to make a new gerrit.
@@ -20,25 +20,42 @@ Commands
     git gerrit-help              List commands.
     git gerrit-install-hooks     Install git hooks to create gerrit change-ids.
     git gerrit-log               Show oneline log with gerrit numbers.
+    git gerrit-number            Show info for a gerrit change number.
     git gerrit-query             Search gerrit.
+    git gerrit-sync              Fetch all changes and update the local database.
     git gerrit-update            Update gerrits matching search terms.
-    git gerrit-unpicked          Find gerrit numbers on upstream branch not cherry picked.
     git gerrit-version           Print version and exit.
 
 Installation
 ============
 
 .. _pipx: https://pipx.pypa.io/stable/
+.. _uv: https://github.com/astral-sh/uv
+
+The recommended way to install **git-gerrit** is with `uv`_ or `pipx`_.
+
+To install with ``uv``, run the following as a regular user:
+
+.. code-block:: console
+
+    uv tool install git-gerrit
+    uv tool update-shell
+
+The ``uv tool update-shell`` command adds the installed commands to your
+shell's PATH.  Restart your shell after running ``update-shell``.
 
-Install with `pipx`_::
+To install with ``pipx_``, run the following as a regular user:
 
-    $ pipx install git-gerrit
+.. code-block:: console
 
-Be sure your ``PATH`` has been updated to run **pipx** installed commands::
+    pipx install git-gerrit
+    pipx ensurepath
 
-    $ pipx ensurepath
+The ``pipx ensurepath`` command adds the installed commands to your shell's
+PATH.  Restart you shell after running ``ensurepath``.
 
-If **pipx** is not available, then install in a project local virtualenv::
+Alternatively, you can install **git-gerrit** directly into a local virtual
+environment with ``pip``::
 
     $ cd <my-project-directory>
     $ python3 -m venv .venv
@@ -46,7 +63,6 @@ If **pipx** is not available, then install in a project local virtualenv::
     (.venv) $ pip install -U pip setuptools
     (.venv) $ pip install git-gerrit
 
-
 Setup
 =====
 
@@ -73,6 +89,16 @@ Setup a local OpenAFS git repo::
     $ git config --local gerrit.project openafs
     $ git gerrit-install-hooks
 
+Fetch all of the change commits from the upstream gerrit system to your local
+repository and create the local sqlite database. This is a heavy weight operation
+and is only needed for **git gerrit-log** and **git gerrit-number**::
+
+    $ git gerrit-sync
+    ✔ Fetching changes from https://gerrit.example.com/example
+    ✔ Updating local database
+    ✔ Scanning commit messages
+    Done.
+
 Find open gerrits on the master branch::
 
     $ git gerrit-query is:open branch:master
@@ -104,7 +130,7 @@ Find gerrits with subjects containing the term 'debuginfo'::
 
 Find the branch names of gerrits with the subject containing the term 'debuginfo'::
 
-    $ git gerrit-query --format='{branch:>20s} {_number} {subject}' debuginfo
+    $ git gerrit-query --format='{branch:>20s} {number} {subject}' debuginfo
                   master 13030 redhat: Make separate debuginfo for kmods work with recent rpm
     openafs-stable-1_6_x 13029 redhat: Create unique debuginfo packages for kmods
     openafs-stable-1_6_x 12818 redhat: separate debuginfo package for kmod rpm
@@ -131,18 +157,18 @@ Checkout a gerrit by number::
 
 Cherry-pick a gerrit onto the current branch::
 
-    $ git gerrit-fetch --no-branch 13001 && git cherry-pick FETCH_HEAD
+    $ git gerrit-fetch 13001 && git cherry-pick FETCH_HEAD
 
 Show gerrit numbers in the checked out branch in the local git repo::
 
-    $ git gerrit-log
+    $ git gerrit-log -n3
     12958 f47cb2d Suppress statement not reached warnings under Solaris Studio
     12957 306f0f3 afs: squash empty declaration warning
     12955 e006609 libafs: git ignore build artifacts on Solaris
 
 Show gerrit numbers by a revision in the local git repo::
 
-    $ git gerrit-log openafs-stable-1_8_0
+    $ git gerrit-log -n3 openafs-stable-1_8_0
     12953 a08327f Update NEWS for 1.8.0 final release
     12938 acb0e84 afs_pioctl: avoid -Wpointer-sign
     12950 b73863b LINUX: fix RedHat 7.5 ENOTDIR issues
@@ -156,20 +182,11 @@ Show gerrit numbers by a range of revisions in the local git repo::
 
 Show just the gerrit numbers and subjects in the local git repo::
 
-    $ git gerrit-log --format='{number}: {subject}'
+    $ git gerrit-log -n3 --format='{number}: {subject}'
     12958: Suppress statement not reached warnings under Solaris Studio
     12957: afs: squash empty declaration warning
     12955: libafs: git ignore build artifacts on Solaris
 
-Show the commits on the master branch which have not been cherry-picked on to
-the stable branch. (Gerrits may already exists for them.)::
-
-    $ git gerrit-unpicked -u origin/master origin/openafs-stable-1_8_x
-    13656 4eeed830fa31b7b8b5487ba619acbc8d30642aaa afscp: Link against opr/roken/hcrypto
-    13659 f5f59cd8d336b153e2b762bb7afd16e6ab1b1ee2 util: serverLog using memory after free
-    13665 1210a8d6d96db2d84595d35ef81ec5d176de05e8 LINUX: Run the 'sparse' checker if available
-    ...
-
 Add reviewers to the **foobar** topic::
 
     $ git gerrit-update --add-reviewer="ty@example.com" branch:master is:open topic:foobar

git_gerrit-3.2.0/git_gerrit/__init__.py

@@ -0,0 +1,62 @@
+# Copyright (c) 2018-2024 Sine Nomine Associates
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS' AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+"""
+Git helpers for the Gerrit code review system, with an emphasis on the Gerrit
+old-style numeric identifiers.
+"""
+
+from git_gerrit.__version__ import VERSION
+from git_gerrit.git import Git
+from git_gerrit.error import (
+    GitGerritError,
+    GitGerritConfigError,
+    GitGerritFormatError,
+    GitGerritNotFoundError,
+)
+from git_gerrit.core import (
+    CHANGE_FIELDS,
+    LOG_FIELDS,
+    cherry_pick,
+    fetch,
+    get_current_change,
+    log,
+    query,
+    sync,
+    update,
+)
+
+_hush_linter = [
+    VERSION,
+    CHANGE_FIELDS,
+    LOG_FIELDS,
+    Git,
+    GitGerritError,
+    GitGerritConfigError,
+    GitGerritFormatError,
+    GitGerritNotFoundError,
+    cherry_pick,
+    fetch,
+    get_current_change,
+    log,
+    query,
+    sync,
+    update,
+]

git_gerrit-3.2.0/git_gerrit/__version__.py

@@ -0,0 +1 @@
+VERSION = "3.2.0"