Test code boilerplate stuff

.github/ISSUE_TEMPLATE/bug_report.md

@@ -29,22 +29,6 @@ about: Report a reproducible bug in the current release of Phabfive
 3.
 
 
-### Schema
-
-<!-- Update me -->
-```
-
-```
-
-
-### Data
-
-<!-- Update me -->
-```
-
-```
-
-
 <!-- What did you expect to happen? -->
 ### Expected Behavior
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -13,8 +13,11 @@ about: Propose a new Phabfive feature or enhancement
 -->
 
 ### Environment
-* Phabfive version: <!-- Example: 1.7.0 -->
-* Python version: <!-- Example: 3.7.0 -->
+<!-- Example: 1.7.0 -->
+* Phabfive version:
+
+<!-- Example: 3.7.0 -->
+* Python version:
 
 <!--
     Describe in detail the new functionality you are proposing. Include any
@@ -32,7 +35,9 @@ about: Propose a new Phabfive feature or enhancement
 -->
 ### Use Case
 
+ * None
+
 
 ### Other?
 
-None
+ * None

Makefile

@@ -37,3 +37,6 @@ bdist: ## build a wheel distribution
 
 install: ## install package
 	python setup.py install
+
+mkdocs-dev:
+	mkdocs serve

README.md

@@ -1,32 +1,18 @@
 # phabfive
 
-A command line tool to interact with Phabricator.
-
-The complete documentation for Phabfive can be found at [Read the Docs](https://phabfive.readthedocs.io/en/latest/)
-
+[![Travis CI](https://travis-ci.com/dynamist/phabfive.svg?branch=master)](https://travis-ci.com/dynamist/phabfive)
+[![Current release](https://img.shields.io/github/v/release/dynamist/phabfive.svg)](https://github.com/dynamist/phabfive/releases)
+[![GitHub issues](https://img.shields.io/github/issues/dynamist/phabfive.svg?maxAge=360)](https://github.com/dynamist/phabfive/issues)
+[![License](https://img.shields.io/github/license/dynamist/phabfive?color=%23fe0000)](https://github.com/dynamist/phabfive/blob/master/LICENSE)
+[![Python2](https://img.shields.io/badge/python2-2.7-blue.svg)](https://github.com/dynamist/phabfive/)
+[![Python3](https://img.shields.io/badge/python3-3.6,3.7,3.8-blue.svg)](https://github.com/dynamist/phabfive/)
 
-## Features
-
-A summary of the currently supported actions, as well as planned features:
+A command line tool to interact with Phabricator.
 
-- Passphrase
-  - [X] Get specified secret
-- Diffusion
-  - [X] List repositories names
-  - [X] Get branches for specified repository
-  - [X] Get clone URI:s for specified repository
-  - [X] Add repository
-  - [X] Edit URI
-  - [X] Observe repositories: create uri
-- Paste
-  - [X] List pastes
-  - [X] Get specified paste
-  - [X] Add paste
-- User
-  - [X] Who am I: information about the logged-in user
+The complete documentation and detailed documentation of all implemented commands for Phabfive can be found at [Read the Docs](https://phabfive.readthedocs.io/en/latest/)
 
 
-## Example usage
+## Basic example
 
 Grab a Phabricator token at https://<yourserver.com>/settings/panel/apitokens/
 
@@ -40,9 +26,11 @@ Usage:
 
     phabfive passphrase K123
 
+More detailed examples can be found on the [Read the Docs](https://phabfive.readthedocs.io/en/latest/) website
+
 
 ## LICENSE
 
-Copyright (c) 2017-2019 Dynamist AB
+Copyright (c) 2017-2020 Dynamist AB
 
 See the LICENSE file provided with the source distribution for full details.

docs/modules/diffusion.md

@@ -0,0 +1,11 @@
+# Module Diffusion
+
+
+## Impelmented commands
+
+- List repositories names
+- Get branches for specified repository
+- Get clone URI:s for specified repository
+- Add repository
+- Edit URI
+- Observe repositories: create uri

docs/modules/passphrase.md

@@ -0,0 +1,6 @@
+# Module Passphrase
+
+
+## Impelmented commands
+
+- Get specified secret

docs/modules/paste.md

@@ -0,0 +1,8 @@
+# Module Paste
+
+
+## Impelmented commands
+
+- List pastes
+- Get specified paste
+- Add paste

docs/modules/user.md

@@ -0,0 +1,6 @@
+# Module User
+
+
+## Impelmented commands
+
+- Who am I: information about the logged-in user

mkdocs.yml

@@ -5,6 +5,11 @@ repo_url: https://github.com/dynamist/phabfive
 nav:
     - Introduction: 'index.md'
     - Development: 'development.md'
+    - Modules:
+        - Diffusion: 'modules/diffusion.md'
+        - Passphrase: 'modules/passphrase.md'
+        - Paste: 'modules/paste.md'
+        - User: 'modules/user.md'
 
 markdown_extensions:
     - admonition:

phabfive/cli.py

@@ -8,7 +8,7 @@
 
 # phabfive imports
 from phabfive import passphrase, diffusion, paste, user
-from phabfive.constants import MONOGRAMS, REPO_STATUS_CHOICES
+from phabfive.constants import *
 from phabfive.exceptions import (
     PhabfiveConfigException,
     PhabfiveDataException,

phabfive/core.py

@@ -39,24 +39,23 @@
 
 class Phabfive(object):
     def __init__(self):
-
         # Get super-early debugging by `export PHABFIVE_DEBUG=1`
         if "PHABFIVE_DEBUG" in os.environ:
             log.setLevel(logging.DEBUG)
             log.info(
-                "Loglevel is: {}".format(logging.getLevelName(log.getEffectiveLevel()))
+                "Loglevel is: {0}".format(logging.getLevelName(log.getEffectiveLevel()))
             )
 
         self.conf = self.load_config()
 
         maxlen = 8 + len(max(dict(self.conf).keys(), key=len))
         for k, v in dict(self.conf).items():
-            log.debug("{} {} {}".format(k, "." * (maxlen - len(k)), v))
+            log.debug("{0} {1} {2}".format(k, "." * (maxlen - len(k)), v))
 
         # check for required configurables
         for k, v in dict(self.conf).items():
             if k in REQUIRED and not v:
-                error = "{} is not configured".format(k)
+                error = "{0} is not configured".format(k)
                 example = CONFIG_EXAMPLES.get(k)
                 if example:
                     error += ", " + example
@@ -65,11 +64,12 @@ def __init__(self):
         # check validity of configurables
         for k in VALIDATORS.keys():
             if not re.match(VALIDATORS[k], self.conf[k]):
-                error = "{} is malformed".format(k)
+                error = "{0} is malformed".format(k)
                 example = VALID_EXAMPLES.get(k)
                 if example:
                     error += ", " + example
                 raise PhabfiveConfigException(error)
+
         self.phab = Phabricator(
             host=self.conf.get("PHAB_URL"), token=self.conf.get("PHAB_TOKEN")
         )
@@ -105,7 +105,7 @@ def load_config(self):
         os.environ["XDG_CONFIG_DIRS"] = "/etc"
 
         site_conf_file = os.path.join(appdirs.site_config_dir("phabfive") + ".yaml")
-        log.debug("Loading configuration file: {}".format(site_conf_file))
+        log.debug("Loading configuration file: {0}".format(site_conf_file))
         anyconfig.merge(
             conf,
             {
@@ -120,7 +120,7 @@ def load_config(self):
         site_conf_dir = os.path.join(
             appdirs.site_config_dir("phabfive") + ".d", "*.yaml"
         )
-        log.debug("Loading configuration files: {}".format(site_conf_dir))
+        log.debug("Loading configuration files: {0}".format(site_conf_dir))
         anyconfig.merge(
             conf,
             {
@@ -131,7 +131,7 @@ def load_config(self):
         )
 
         user_conf_file = os.path.join(appdirs.user_config_dir("phabfive")) + ".yaml"
-        log.debug("Loading configuration file: {}".format(user_conf_file))
+        log.debug("Loading configuration file: {0}".format(user_conf_file))
         anyconfig.merge(
             conf,
             {
@@ -146,7 +146,7 @@ def load_config(self):
         user_conf_dir = os.path.join(
             appdirs.user_config_dir("phabfive") + ".d", "*.yaml"
         )
-        log.debug("Loading configuration files: {}".format(user_conf_dir))
+        log.debug("Loading configuration files: {0}".format(user_conf_dir))
         anyconfig.merge(
             conf,
             {

phabfive/diffusion.py

@@ -4,12 +4,7 @@
 import re
 
 # phabfive imports
-from phabfive.constants import (
-    DISPLAY_CHOICES,
-    IO_NEW_URI_CHOICES,
-    MONOGRAMS,
-    REPO_STATUS_CHOICES,
-)
+from phabfive.constants import *
 from phabfive.core import Phabfive
 from phabfive.exceptions import PhabfiveDataException, PhabfiveConfigException
 from phabfive import passphrase

phabfive/passphrase.py

@@ -7,7 +7,7 @@
 
 # phabfive imports
 from phabfive.core import Phabfive
-from phabfive.constants import MONOGRAMS
+from phabfive.constants import *
 from phabfive.exceptions import PhabfiveDataException, PhabfiveRemoteException
 
 # 3rd party imports

phabfive/paste.py

@@ -6,7 +6,7 @@
 # phabfive imports
 from phabfive.core import Phabfive
 from phabfive.exceptions import PhabfiveDataException
-from phabfive.constants import MONOGRAMS
+from phabfive.constants import *
 
 # 3rd party imports
 from phabricator import APIError
@@ -21,6 +21,9 @@ def _validate_identifier(self, id_):
 
     def _convert_ids(self, ids):
         """Method used by print function."""
+        if not isinstance(ids, list):
+            raise PhabfiveDataException("variable ids must be of list type")
+
         ids_list_int = []
 
         for id_ in ids:
@@ -48,12 +51,14 @@ def create_paste(
 
         :rtype: dict
         """
-        text = None
         tags = tags if tags else []
         subscribers = subscribers if subscribers else []
 
-        with open(file, "r") as f:
-            text = f.read()
+        if file:
+            with open(file, "r") as f:
+                text = f.read()
+        else:
+            text = None
 
         transactions = []
         transactions_values = [

setup.py

@@ -19,9 +19,9 @@
     CHANGELOG = f.read()
 
 install_requires = ["anyconfig", "appdirs", "phabricator", "pyyaml", "docopt"]
-tests_require = ["coverage", "flake8", "pytest", "tox"]
-docs_require = ["docs"]
-download_url = "{}/tarball/v{}".format(
+tests_require = ["coverage", "flake8", "pytest", "tox", "mock"]
+docs_require = ["mkdocs"]
+download_url = "{0}/tarball/v{1}".format(
     "https://github.com/dynamist/phabfive", phabfive.__version__
 )
 
@@ -41,7 +41,7 @@
     extras_require={"test": tests_require, "docs": docs_require},
     packages=["phabfive"],
     entry_points={"console_scripts": ["phabfive = phabfive.cli:cli_entrypoint"]},
-    python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
+    python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*",
     classifiers=[
         # 'Development Status :: 1 - Planning',
         # "Development Status :: 2 - Pre-Alpha",
@@ -56,9 +56,9 @@
         "Environment :: Console",
         "Programming Language :: Python",
         "Programming Language :: Python :: 2.7",
-        "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
         "License :: OSI Approved :: Apache Software License",
         "Natural Language :: English",
     ],