v2.1.4.0: a wrapper! (pb command)

Also, got some other refinements done. Note to self: correct pep8 errors for the next release. Signed-off-by: Kwpolska <[email protected]>
Kwpolska · Sep 4, 2012 · 642c747 · 642c747
1 parent 2dc79d8
commit 642c747
Show file tree

Hide file tree

Showing 38 changed files with 597 additions and 295 deletions.
diff --git a/PKGBUILD b/PKGBUILD
@@ -1,6 +1,6 @@
 # Maintainer: Kwpolska <[email protected]>
 pkgname=pkgbuilder
-pkgver=2.1.3.7
+pkgver=2.1.4.0
 pkgrel=1
 pkgdesc='A Python AUR helper/library.'
 arch=('any')
@@ -9,7 +9,7 @@ license=('BSD')
 depends=('python' 'pyalpm>=0.5.1-1' 'python-requests')
 options=(!emptydirs)
 source=("http://pypi.python.org/packages/source/p/${pkgname}/${pkgname}-${pkgver}.tar.gz")
-md5sums=('1f6613ea44e5186610a5245e7e16a20a')
+md5sums=('aa83d7b4f16adf2c8d64ad744f5d2590')
 
 package() {
   cd "${srcdir}/${pkgname}-${pkgver}"

diff --git a/README b/README
@@ -3,8 +3,8 @@ PKGBUILDer.  An AUR helper (and library) in Python 3.
 =====================================================
 :Info: This is the README file for PKGBUILDer.
 :Author: Kwpolska <[email protected]>
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index: README
 

diff --git a/README.rst b/README.rst
@@ -3,8 +3,8 @@ PKGBUILDer.  An AUR helper (and library) in Python 3.
 =====================================================
 :Info: This is the README file for PKGBUILDer.
 :Author: Kwpolska <[email protected]>
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index: README
 

diff --git a/dist/pkgbuilder-2.1.3.7.tar.gz b/dist/pkgbuilder-2.1.3.7.tar.gz
diff --git a/dist/pkgbuilder-2.1.4.0.tar.gz b/dist/pkgbuilder-2.1.4.0.tar.gz
diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
@@ -3,8 +3,8 @@ Appendix C. Changelog
 =====================
 :Info: This is a partial changelog for PKGBUILDer.
 :Author: Kwpolska <[email protected]>
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index:: CHANGELOG
 

diff --git a/docs/LICENSE.rst b/docs/LICENSE.rst
@@ -3,8 +3,8 @@ Appendix B. License for PKGBUILDer
 ==================================
 :Info: This is an appendix to the PKGBUILDer documentation.
 :Author: Kwpolska <[email protected]>
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index:: LICENSE
 

diff --git a/docs/README.rst b/docs/README.rst
@@ -3,8 +3,8 @@ PKGBUILDer.  An AUR helper (and library) in Python 3.
 =====================================================
 :Info: This is the README file for PKGBUILDer.
 :Author: Kwpolska <[email protected]>
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index: README
 

diff --git a/docs/aur.rst b/docs/aur.rst
@@ -3,8 +3,8 @@ aur module (AUR class)
 ======================
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. module:: aur
 

diff --git a/docs/build.rst b/docs/build.rst
@@ -3,8 +3,8 @@ build module (Build class)
 ==========================
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. module:: build
 
@@ -100,7 +100,7 @@ Extracts an AUR tarball.  Data normally provided by :meth:`build_runner()`.
 
 Gets (make)depends from a PKGBUILD and returns them.
 
-..note:: due to a radical change of the algorithm, please provide the **absolute** path to the PKGBUILD (``os.path.abspath``).  Handles are not supported.  For a short while, strings will still be supported, but will raise an error.
+..note:: due to a radical change of the algorithm, please provide the **absolute** path to the PKGBUILD (``os.path.abspath``).  Handles are not supported.  Strings are not supported since 2.1.4.0.
 
 .. method:: depcheck(depends)
 .. index:: depcheck, dependency

diff --git a/docs/conf.py b/docs/conf.py
@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '2.1.3'
 # The full version, including alpha/beta/rc tags.
-release = '2.1.3.7'
+release = '2.1.4.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/main.rst b/docs/main.rst
@@ -3,8 +3,8 @@ main module
 ===========
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index:: main
 .. versionadded:: 2.1.3.0

diff --git a/docs/messagecodes.rst b/docs/messagecodes.rst
@@ -3,8 +3,8 @@ Appendix A. PKGBUILDer message codes list
 =========================================
 :Info: This is an appendix to the PKGBUILDer documentation.
 :Author: Kwpolska <[email protected]>
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. index:: Message Codes
 

diff --git a/docs/pb.8.gz b/docs/pb.8.gz
diff --git a/docs/pb.rst b/docs/pb.rst
@@ -0,0 +1,76 @@
+=========
+PBWrapper
+=========
+
+:Author: Kwpolska <[email protected]>
+:Copyright: See Appendix B.
+:Date: 2012-09-04
+:Version: 2.1.4.0
+:Wrapper Version: 0.1.0
+:Manual section: 8
+:Manual group: PKGBUILDer manual
+
+SYNOPSIS
+========
+
+*pb* <operation> [options] [targets]
+
+DESCRIPTION
+===========
+
+*PBWrapper* (also known as just *pb*) is a wrapper for pacman and
+PKGBUILDer, i.e. an application which handles checking if a package is
+in the official repos or in the AUR and installs them according to that
+information.
+
+It is a part of PKGBUILDer and is included since version 2.1.4.0 of
+PKGBUILDer.
+
+OPERATIONS AND OPTIONS
+======================
+
+All operations and options from pacman and PKGBUILDer work.  Operations
+other than **-S, --sync** are passed as-is to pacman.  The **-S,
+--sync** switch activates a check for other parameters.  If one of
+**-syu** (**--search --refresh --sysupgrade**) is present, the requests
+are passed to pacman and PKGBUILDer, in that order, with arguments that
+apply to the manager and nothing else.  If any other operations are
+present (including **-i, --info**), the **targets** provided are checked
+for presence in the AUR.  If a package is in the AUR, it is addded to
+the queue that will be passed to PKGBUILDer, otherwise it is added to a
+pacman queue.  Please note that brand new options will not work until
+the next PKGBUILDer/PBWrapper release.
+
+The **--debug** option enables additional debug information from
+PBWrapper.
+
+EXAMPLES
+========
+
+pb -S python trashman
+    Installs the Python interpreter from the repos (which is already on
+    your system, especially if you have installed PKGBUILDer/PBWrapper)
+    and Trashman from the AUR.
+
+pb -Si python trashman
+    Shows information for the python and trashman packages.
+
+pb -Syu
+    Checks for repo and AUR updates (in that order) and offers
+    installing them.
+
+(Trashman is an XDG trash manager by Kwpolska.  Python is the awesome
+language both Trashman and PKGBUILDer/PBWrapper are written in.)
+
+SEE ALSO
+========
+**pacman(8)**, **pkgbuilder(8)**, **makepkg(8)**, **PKGBUILD(5)**
+
+You can visit the git repo at <https://github.com/Kwpolska/pkgbuilder>
+for more info.
+
+BUGS
+====
+Bugs should be reported at the GitHub page
+(<https://github.com/Kwpolska/pkgbuilder/issues>), with the PBWrapper
+label.  You can also send mail to <[email protected]>.
diff --git a/docs/pbds.rst b/docs/pbds.rst
@@ -4,8 +4,8 @@ pbds module (PBDS class)
 
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. module: pbds
 
@@ -75,11 +75,11 @@ information:
 
 It also has a few methods:
 
-.. method:: debugout()
+.. method:: debugout(nochange)
 
 .. versionadded:: 2.1.4.0
 
-:Arguments: none.
+:Arguments: make no changes if not necessary.
 :Input: none.
 :Output: none.
 :Returns: nothing.

diff --git a/docs/pkgbuilder.8.gz b/docs/pkgbuilder.8.gz
diff --git a/docs/pkgbuilder.rst b/docs/pkgbuilder.rst
@@ -4,15 +4,15 @@ PKGBUILDer
 
 :Author: Kwpolska <[email protected]>
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 :Manual section: 8
 :Manual group: PKGBUILDer manual
 
 SYNOPSIS
 ========
 
-*pkgbuilder* [-hVcdvwSy] [-p PROTOCOL] [-isu] [PACKAGE [PACKAGE ...]]
+*pkgbuilder* [-hVcdvwSy] [-P PROTOCOL] [-isu] [PACKAGE [PACKAGE ...]]
 
 DESCRIPTION
 ===========
@@ -63,7 +63,7 @@ OPTIONS
 **-w, --buildonly**
     Skips package installation after building.
 
-**-p PROTOCOL, --protocol PROTOCOL**
+**-P PROTOCOL, --protocol PROTOCOL**
     Chooses the protocol, http by default.
 
 **-S, --sync**
@@ -87,10 +87,13 @@ pkgbuilder -S trashman
 pkgbuilder -Syu
     Checks for updates and offers installing them.
 
-(Trashman is an XDG trash manager by Kwpolska.)
+(Trashman is an XDG trash manager by Kwpolska, which you should install.)
 
 SEE ALSO
 ========
+**pb(8)**, a wrapper for pacman and PKGBUILDer, included with PKGBUILDer, also
+known as PBWrapper.
+
 **pacman(8)**, **makepkg(8)**, **PKGBUILD(5)**
 
 You can visit the git repo at <https://github.com/Kwpolska/pkgbuilder>

diff --git a/docs/upgrade.rst b/docs/upgrade.rst
@@ -4,8 +4,8 @@ upgrade module (Upgrade class)
 
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. module:: upgrade
 

diff --git a/docs/utils.rst b/docs/utils.rst
@@ -4,8 +4,8 @@ utils module (Utils class)
 
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 
 .. module:: utils
 

diff --git a/docs/wrapper.rst b/docs/wrapper.rst
@@ -3,8 +3,8 @@ PBWrapper
 =========
 :Author: Kwpolska
 :Copyright: See Appendix B.
-:Date: 2012-08-26
-:Version: 2.1.3.7
+:Date: 2012-09-04
+:Version: 2.1.4.0
 :PBWrapper Version: 0.1.0
 
 .. index:: wrapper
@@ -26,3 +26,6 @@ with additional arguments applicable to one or another.
 .. note:: Actually, pkgbuilder isn’t called as a subprocess, the arguments are
     just passed to the main() function, so no time is wasted on reloading
     everything.
+
+.. note:: Currently, the -P --protocol argument is not supported.  It will be fixed
+    as soon as possible.
diff --git a/locale/en/LC_MESSAGES/pkgbuilder.mo b/locale/en/LC_MESSAGES/pkgbuilder.mo