Merge pull request #8 from robertopreste/dev

Version 0.3.0

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+rtdocs/
 
 # PyBuilder
 target/

HISTORY.rst

@@ -54,3 +54,9 @@ History
 * Add Drone CI class and CLI commands;
 * Update tests;
 * Update documentation.
+
+0.3.0 (2019-07-28)
+==================
+
+* Add ``--branch`` option to check for specific branch;
+* Update documentation.

README.rst

@@ -32,6 +32,7 @@ Have a quick look at the status of CI projects from the command line.
 Features
 ========
 
+quickCI allows to have a quick overview of the status of build jobs on several CI services, for a specific branch of the repository being built.
 Currently, quickCI supports checking build status for the following CI services:
 
 * `Travis CI`_
@@ -48,7 +49,7 @@ Usage
 Configuration
 -------------
 
-1. Create a config file (it will be located in ``~/.config/quickci/tokens.json``::
+1. Create a config file (it will be located in ``~/.config/quickci/tokens.json``)::
 
     $ quickci config create
 
@@ -74,8 +75,12 @@ Check the build status of your projects::
 
     $ quickci status
 
-The build status of your Travis CI, CircleCI, AppVeyor, Buddy and Drone projects will be returned (currently only master branch).
+The build status of your Travis CI, CircleCI, AppVeyor, Buddy and Drone projects will be returned (``master`` branch).
+If you want to monitor one specific branch of your repositories (suppose you have many repos with a dedicated ``dev`` branch for development), you can easily add the ``--branch <branch_name>`` option::
 
+    $ quickci status --branch dev
+
+If the ``--branch`` option is not provided, the build status of the ``master`` branch will be retrieved by default.
 It is also possible to check a specific service using subcommands of ``quickci status``::
 
     $ quickci status travis
@@ -84,6 +89,7 @@ It is also possible to check a specific service using subcommands of ``quickci s
     $ quickci status buddy
     $ quickci status drone
 
+These subcommands also accept the ``--branch`` option.
 If the token for a specific service is not listed in ``~/.config/quickci/tokens.json``, it is possible to provide it using the ``--token <service_token>`` option::
 
     $ quickci status travis --token <TravisCI token>

docs/api.rst

@@ -0,0 +1,11 @@
+===
+API
+===
+
+.. click:: quickci.commands.status:status
+    :prog: quickci status
+    :show-nested:
+
+.. click:: quickci.commands.config:config
+    :prog: quickci config
+    :show-nested:

docs/conf.py

@@ -33,7 +33,8 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx_click.ext',
+              'sphinxcontrib.napoleon']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -58,10 +59,10 @@
 #
 # The short X.Y version.
 # version = quickci.__version__
-version = "0.2.4"
+version = "0.3.0"
 # The full version, including alpha/beta/rc tags.
 # release = quickci.__version__
-release = "0.2.4"
+release = "0.3.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -10,7 +10,7 @@ Table of contents
    readme
    installation
    usage
-   modules
+   api
    contributing
    authors
    history

docs/usage.rst

@@ -14,25 +14,30 @@ Command Line Interface
 ``quickci status``
 ------------------
 
-This command retrieves the status of the master branch of your projects on one or more CI services.
+This command retrieves the status of your projects on one or more CI services (``master`` branch by default).
 
 If issued as ``quickci status``, will retrieve these information for all the CI services for which an authentication token is available in the config file::
 
     $ quickci status
 
-    CircleCI
+    CircleCI (master branch)
         project1 -> success
         project2 -> failed
-    Travis CI
+    Travis CI (master branch)
         project1 -> passed
         project2 -> passed
-    AppVeyor
+    AppVeyor (master branch)
         project1 -> passed
-    Buddy
+    Buddy (master branch)
         project2 -> enqueued
-    Drone CI
+    Drone CI (master branch)
         project1 -> success
 
+If you want to monitor one specific branch of your repositories (suppose you have many repos with a dedicated ``dev`` branch for development), you can easily add the ``--branch <branch_name>`` option::
+
+    $ quickci status --branch dev
+
+If the ``--branch`` option is not provided, the build status of the ``master`` branch will be retrieved by default.
 It is also possible to check a specific service using subcommands of ``quickci status``::
 
     $ quickci status travis
@@ -41,6 +46,12 @@ It is also possible to check a specific service using subcommands of ``quickci s
     $ quickci status buddy
     $ quickci status drone
 
+These subcommands also accept the ``--branch`` option::
+
+    $ quickci status travis --branch master
+    $ quickci status circle --branch feature1
+    $ quickci status drone --branch new_feature
+
 If you have not set up a config file, you can still retrieve information from CI services providing their authentication token right into the command::
 
     $ quickci status travis --token <TRAVIS_CI_TOKEN>
@@ -51,11 +62,17 @@ If you have not set up a config file, you can still retrieve information from CI
 
 This command allows to create a config file for ``quickci``, or update it if a config file is already available.
 
-The ``create`` command will create a brand new config file, located in ``~/.config/quickci/tokens.json``. If a config file is already present at that location, you will be prompted to confirm your desire to clear it and create a new one. New config files fill the authentication tokens with a temporary string, which you will need to update with proper tokens.
+The ``create`` command will create a brand new config file, located in ``~/.config/quickci/tokens.json``::
+
+    $ quickci config create
+
+If a config file is already present at that location, you will be prompted to confirm your desire to clear it and create a new one. New config files fill the authentication tokens with a temporary string, which you will need to update with proper tokens.
 
 The ``update`` command allows to update one of the authentication tokens in the existing config file::
 
     $ quickci config update <CIservice> <token>
 
-The ``show`` command will show all the stored authentication tokens.
+The ``show`` command will show all the stored authentication tokens::
+
+    $ quickci config show
 

quickci/__init__.py

@@ -4,4 +4,4 @@
 
 __author__ = """Roberto Preste"""
 __email__ = "robertopreste@gmail.com"
-__version__ = '0.2.4'
+__version__ = '0.3.0'