2.1.0 Added human_name, refactored setuppy + more

**New features:**

 - Added new function `human_name` to `helpers.common` which humanises a function/class name

 - Converted `setuppy.py` into a python module folder at `setuppy/`

 - Added new distutils extras:

     - `extras/setuppy.txt` to cover all setuppy optional requirements
     - `extras/docs.txt` contains requirements for building the Sphinx documentation
     - `extras/dev.txt` is a meta-extra which includes all extra requirements for development via `full`, `docs` and `tests`

 - Created `privex.helpers.setuppy.bump`

     - Most notably, this module contains a function `bump_version` which uses the package `semver` to bump a version number.
       The version number is extracted from a python package file configured in `settings.VERSION_FILE` and after it's updated,
       the file containing the version is automatically updated with the new version number.

 - Created `privex.helpers.setuppy.commands` which contains setup.py / distutils command classes

     - `BumpCommand` is a command class which allows you to bump the version of a python package, including updating the file containing the version,
       simply by running a command such as `./setup.py bump --minor`
     - `ExtrasCommand` is a command class which helps with managing your package's `extra_require` by offering these features:

         - With no arguments, `./setup.py extras` would output a list of all requirements listed for each extra in your `extras_require`
         - With the `--save=somefile.txt` argument, the requirements can be outputted into a file
         - With the `--install` argument, the requirements will be installed with `pip` using the python version which is running setup.py
         - With the `--extra=myextra` argument, only requirements for that individual extra will be listed/saved/installed

 - Added unit tests for `human_name` in `tests/test_general.py`
 - Created `tests/test_net.py` for network related unit tests

**General changes / improvements:**

 - Added `__all__` to some modules, to reduce un-necessary objects being imported when you do wildcard imports such as `from privex.helpers import *`

 - Moved `EXTRAS_FOLDER` into helpers.settings for consistency and easier changing

 - Moved the various requirements.txt / extras related functions from `setuppy.py` into `helpers.setuppy.common`

 - Moved network related tests from `test_general.py` into the new `test_net.py`

 - The `setup.py` used for privex-helpers itself now has the commands `bump` and `extras` available, which uses the
   new command classes from `privex.helpers.setuppy.commands`

 - The file `privex/helpers/__init__.py` now imports `privex.loghelper` inside of a try/except block, so if for some strange reason
   `privex-loghelper` isn't installed or is broken, then it will fallback to standard `logging.getLogger` instead of just breaking

 - Fixed various issues with PyDoc blocks in several files, such as `cache.KeyManager` and `crypto.RedisCache`

 - Travis-CI now uses `pip install -U '.[dev]'` instead of installing the requirements file `docs/requirements.txt` and package

 - ReadTheDocs now uses `pip install -U '.[dev]'` instead of installing the requirements file `docs/requirements.txt`

 - Possibly other small fixes / changes

**Documentation related:**

 - Listed some of the new `setuppy` functionality in the overview in README.md

 - Updated the `docs/requirements.txt` file to include all important requirements

 - Updated the `module.rst` autosummary template to include attributes (if possible)

 - Updated the `class.rst` autosummary template so inherited attributes / methods are ignored (generated unit test class docs were often really spammy)

 - Added detailed documentation for the `privex.helpers.setuppy` module

 - Added an autosummary block for `privex.helpers.settings` so that it can correctly show the settings in the navigation

 - Fixed up several module/class rst files with `:noindex:` and other minor fixes to reduce the amount of warnings when building the docs

 - Re-organised the navigation tree for some modules to make it easier to use

**Melded commits from develop branch**

 - fix __all__ on dynamically loaded functions

 - forgot to include extras/tests.txt in dev.txt

Author: Someguy123

.readthedocs.yml

@@ -13,7 +13,7 @@ formats: all
 # Install package + docs requirements
 python:
   version: 3.7
-  install:
-    - requirements: docs/requirements.txt
-    - method: setuptools
-      path: .
+  pip_install: true
+  extra_requirements:
+    - dev
+

.travis.yml

@@ -3,8 +3,6 @@ services:
   - redis-server
 language: python
 cache: pip
-env:
-  - CODECOV_TOKEN="e309d317-ca30-4c79-a01c-f4dc7c60e471"
 python:
   - "3.6"
   - "3.7"
@@ -16,8 +14,7 @@ before_install:
   - sudo apt-get update -qy
   - sudo apt-get install -qy iputils-ping
 install:
-  - pip install -U -r docs/requirements.txt
-  - pip install -U .
+  - pip install -U '.[dev]'
 script: pytest --cov=./privex -v
 after_success:
   - codecov

README.md

@@ -41,7 +41,7 @@ pipenv install privex-helpers    # If you use pipenv (and you should!)
 pip3 install privex-helpers      # Otherwise, standard pip installation
 
 # If you're using privex-helpers in a project, then you may want to install with the "full" extras
-# which installs all optional requirements (other than Django), so you can use **everything** in privex-helpers
+# which installs all optional requirements (other than Django/tests), so you can use **everything** in privex-helpers
 pipenv install 'privex-helpers[full]'    # If you use pipenv (and you should!)
 pip3 install 'privex-helpers[full]'      # Otherwise, standard pip installation
 ```
@@ -89,6 +89,8 @@ and may not work if you're reading this README.md elsewhere.
     6.1 [Modules with dependencies](#modules-with-dependencies)
 
     6.2 [Using Setuptools Extras](#using-setuptools-extras)
+    
+    6.3 [Installing extras when using the cloned repository](#installing-extras-when-using-the-cloned-repository)
 
 7. [Unit Tests](#unit-tests)
 8. [Contributing](#contributing)
@@ -174,6 +176,16 @@ This is not an exhaustive list, and may sometimes be a little outdated. To see e
 
  - `setuppy` - a module with various functions to help with making python packages or dealing with 
    requirements.txt files
+     - `common.extras_require` - A helper function which allows you to generate an `extras_require` setting in
+       setup.py simply by passing a list of extras names, e.g. `extras_require=extras_require(['cache', 'net']),`
+     - `bump.bump_version` - Bumps a certain part of a package's semver version number and updates the file containing
+       the version
+     - `commands.BumpCommand` - A setup.py command class, which allows you to use `bump.bump_version` within
+       your package, just by typing a command such as `./setup.py bump --minor` (bumps your package's minor 0.x.0
+       version and updates the file which contains the version)
+     - `commands.ExtrasCommand` - Exposes various functionality for managing `extras_require` in your package,
+       including easily generating/saving requirements.txt files for your extras, installing the requirements, 
+       and outputting a list of extras.
 
  - `decorators` - various decorators to simplify your code
      - `retry_on_err` - automatically re-run a function/method when exceptions are thrown, with a variety of
@@ -357,16 +369,32 @@ As of version 2.0.0 - Privex Helpers now supports **Setuptools Extras**, allowin
 to specify extra dependencies related to privex-helpers in your requirements.txt, or when running
 **pip3 install**.
 
-```
-# full: Install all extra dependencies if they aren't already installed
-#   NOTE: Excludes the `django` extras, because Django + sub-deps weighs ~30-50mb - plus you'd normally only
-#   be using the `django` module in a Django project, where you'd have the deps installed anyway...
-#
-# crypto:   Install dependencies related to the `crypto` module
-# cache:    Install dependencies related to the `cache` module
-# django:   Install dependencies related to the `django` module
-# net:      Install dependencies related to the `net` module
+**What is each extra for?**
+
+Extras designed for using the `privex-helpers` package in a project/package:
+
+ - **full**     - A meta-extra which includes most other extras required for full functionality of the library.
+     - It does **NOT** include the `django` extra, because the `Django` package and it's sub-dependencies results in
+       a good 30-50mb of packages being installed, and those who would use the `django` module probably already 
+       have `Django` installed...
+     - It does **NOT** include the `docs` or `tests` extras, as those two are only required for building the
+       documentation, or running the unit tests.
+ - **crypto**   - Install dependencies required to use the `crypto` module
+ - **cache**    - Install optional dependencies to enable all cache backends in `cache`
+ - **django**   - Install dependencies related to the `django` module (including `Django` itself)
+ - **net**      - Install optional dependencies to enable full functionality of the `net` module
+ - **setuppy**  - Install optional dependencies to enable full functionality of the `setuppy` modules
+
+Extras designed for use when developing, testing, documenting, or building `privex-helpers`:
+
+ - **dev**      - Includes everything required for development and related activities with `privex-helper`.
+                  Generally includes ALL extras, unlike `full` this includes `django`, `docs` and `tests`
+ - **docs**     - This extra is not required for privex-helpers modules. It contains requirements for building the docs.
+ - **tests**    - Not required for privex-helpers module usage. Contains requirements for running the unit tests.
 
+**Using the extras with pip install**
+
+```
 # Example: Install privex-helpers AND all optional dependencies (excluding django), for full functionality
 pip3 install 'privex-helpers[full]'
 
@@ -391,8 +419,45 @@ redis>=3.3.8
 cryptography>=2.8
 ```
 
+### Installing extras when using the cloned repository
+
+First, it's recommended to install the requirements in `extras/setuppy.txt` to ensure setup.py functions fully.
+
+```bash
+pip3 install -r extras/setuppy.txt
+```
+
+As of privex-helpers 2.1.0, you can use the handy setup.py `extras` command to install individual extras requirements,
+or all extra requirements painlessly:
+
+```bash
+# Install ALL extras requirements (including Django and unit testing related)
+./setup.py extras -i
+
+# Install an individual extras requirements, for example 'cache' or 'net'
+./setup.py extras -i -e cache
+```
+
+If you just want to install the `privex-helpers` package from source, then you can use pip to install
+the current folder, and specify the extras you want:
+
+```bash
+# Standard "full" install, excluding Django and development packages for docs/testing
+pip3 install '.[full]'
+# Full development installation, includes everything in 'full', with the addition of the django, docs, and tests extras
+pip3 install '.[dev]'
+``` 
+ 
 ### Modules with dependencies
 
+If you're using `privex-helpers` within a normal project (not a package), then it's recommended to simply
+install `privex-helpers[full]` which includes all main dependencies for full functionality. 
+
+If you're using it inside of a package, then you should only require the extras that are critical to your package
+functioning. Anything non-essential should be placed in the `extras_require` of your setup.py to avoid 
+un-necessary packages being installed on your users.
+
+
 **Modules which require a dependency to use them**
 
  - `crypto` - This module won't work at all without the `cryptography` library (or `privex-helpers[crypto]`)
@@ -401,10 +466,16 @@ cryptography>=2.8
 
 **Dynamic modules which simply enable additional features if you install certain packages**
 
+ - `setuppy` - The `common` sub-module should generally work without any dependencies, but to be able to use all 
+   functionality of this module such as the `bump` and `commands` sub-modules, you'll need to install with the
+   `setuppy` extra, e.g. `privex-helpers[setuppy]`
  - `net` - Some functions are dependent on `dnspython` (or `privex-helpers[net]`), but the majority of the module 
    is dependency-free
  - `cache` - The cache layer works just fine without any dependencies. If you're using `privex-helper` within a project,
    then you may want to install `redis` (or `privex-helpers[cache]`) to make the Redis cache adapter available.
+ - `plugin` - While this module isn't very often used within other projects/packages, it does expose some
+   Redis singleton management functions (and possibly others at the time of writing). If you plan on using
+   this module, we recommend using `privex-helpers[full]` for the best experience.
 
 
 # Unit Tests
@@ -468,4 +539,4 @@ If you'd rather read the whole legal text, it should be included as `privex_cont
 
 **If this project has helped you, consider [grabbing a VPS or Dedicated Server from Privex](https://www.privex.io).**
 
-**Prices start at as little as US$8/mo (we take cryptocurrency!)**
+**Prices start at as little as US$8/mo (we take cryptocurrency!)**

docs/requirements.txt

@@ -16,7 +16,9 @@ Methods
 .. autosummary::
    :toctree: {{ name | lower }}
 {% for item in methods %}
-   ~{{ name }}.{{ item }}
+{%- if item not in inherited_members %}
+    ~{{ name }}.{{ item }}
+{%- endif %}
 {%- endfor %}
 {% endif %}
 {% endblock %}
@@ -31,7 +33,9 @@ Attributes
 .. autosummary::
    :toctree: {{ name | lower }}
 {% for item in attributes %}
-   ~{{ name }}.{{ item }}
+{%- if item not in inherited_members %}
+    ~{{ name }}.{{ item }}
+{%- endif %}
 {%- endfor %}
 {% endif %}
 {% endblock %}

docs/source/_templates/autosummary/class.rst

@@ -2,6 +2,18 @@
 
 .. automodule:: {{ fullname }}
 
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: {{ name | lower }}
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
    {% block functions %}
    {% if functions %}
    .. rubric:: Functions

docs/source/_templates/autosummary/module.rst

@@ -16,10 +16,14 @@
 
 import os
 import sys
+from os.path import dirname, abspath
+
 import sphinx_rtd_theme
 
 # Add base directory of the project to the path
-sys.path.insert(0, os.path.abspath('../..'))
+BASE_DIR = dirname(dirname(dirname(abspath(__file__))))
+
+sys.path.insert(0, BASE_DIR)
 
 # -- Project information -----------------------------------------------------
 
@@ -180,5 +184,6 @@
     'python': ('https://docs.python.org/3.6', None),
     'cryptography': ('https://cryptography.io/en/latest/', None),
     'django': ('http://django.readthedocs.org/en/latest/', None),
+    'semver': ('https://python-semver.readthedocs.io/en/latest/', None),
 }
 

docs/source/conf.py

@@ -4,9 +4,10 @@ CacheAdapter
 .. currentmodule:: privex.helpers.cache.CacheAdapter
 
 .. autoclass:: CacheAdapter
-
+   :noindex:
 
    .. automethod:: __init__
+      :noindex:
 
 
    .. rubric:: Methods
@@ -25,4 +26,3 @@ CacheAdapter
 
 
 
-   

docs/source/helpers/cache/privex.helpers.cache.CacheAdapter.CacheAdapter.rst

@@ -4,9 +4,10 @@ MemoryCache
 .. currentmodule:: privex.helpers.cache.MemoryCache
 
 .. autoclass:: MemoryCache
-
+   :noindex:
 
    .. automethod:: __init__
+      :noindex:
 
 
    .. rubric:: Methods
@@ -25,4 +26,3 @@ MemoryCache
 
 
 
-   

docs/source/helpers/cache/privex.helpers.cache.MemoryCache.MemoryCache.rst

@@ -4,10 +4,11 @@ RedisCache
 .. currentmodule:: privex.helpers.cache.RedisCache
 
 .. autoclass:: RedisCache
+   :noindex:
 
 
    .. automethod:: __init__
-
+      :noindex:
 
    .. rubric:: Methods
 
@@ -32,4 +33,3 @@ RedisCache
 
       ~RedisCache.pickle_default
 
-