moved examples, variable info from READme to REFERENCE.

Author: danquack

README.md

@@ -38,284 +38,9 @@ puppet module install stankevich-python
 ```
 
 ## Usage
-
-### python
-
-Installs and manages python, python-pip, python-dev, python-virtualenv and Gunicorn.
-
-**ensure** - Desired installation state for the Python package. Options are absent, present and latest. Default: present
-
-**version** - Python version to install. Default: system
-
-**pip** - Desired installation state for the python-pip package. Options are absent, present and latest. Default: present
-
-**dev** - Desired installation state for the python-dev package. Options are absent, present and latest. Default: absent
-
-**virtualenv** - Desired installation state for the virtualenv package. Options are absent, present and latest. Default: absent
-
-**gunicorn** - Desired installation state for Gunicorn. Options are absent, present and latest. Default: absent
-
-**manage_gunicorn** - Allow Installation / Removal of Gunicorn. Default: true
-
-**use_epel** - Boolean to determine if the epel class is used. Default: true on RHEL like systems, false otherwise
-
-*Install Python from system python*
-```puppet
-  class { 'python' :
-    version    => 'system',
-    pip        => 'present',
-    dev        => 'absent',
-    virtualenv => 'absent',
-    gunicorn   => 'absent',
-  }
-```
-*Install Python 3 from the scl repo*
-```puppet
-  class { 'python' :
-    ensure      => 'present',
-    version     => 'rh-python36-python',
-    dev         => 'present',
-    virtualenv  => 'present',
-  }
-```
-
-### python::pip
-
-Installs and manages packages from pip.
-
-**pkgname** - the name of the package to install. Required.
-
-**ensure** - present/latest/absent. You can also specify the version. Default: present
-
-**virtualenv** - virtualenv to run pip in. Default: system (no virtualenv)
-
-**pip_provider** - pip provider to execute pip with. Default: pip.
-
-**url** - URL to install from. Default: none
-
-**owner** - The owner of the virtualenv to ensure that packages are installed with the correct permissions (must be specified). Default: root
-
-**proxy** - Proxy server to use for outbound connections. Default: none
-
-**environment** - Additional environment variables required to install the packages. Default: none
-
-**extras** - Extra features provided by the package which should be installed. Default: none
-
-**egg** - The egg name to use. Default: `$name` of the class, e.g. cx_Oracle
-
-**install_args** - String of additional flags to pass to pip during installaton. Default: none
-
-**uninstall_args** - String of additional flags to pass to pip during uninstall. Default: none
-
-**timeout** - Timeout for the pip install command. Defaults to 1800.
-
-*Install cx_Oracle with pip*
-```puppet
-  python::pip { 'cx_Oracle' :
-    pkgname       => 'cx_Oracle',
-    ensure        => '5.1.2',
-    virtualenv    => '/var/www/project1',
-    owner         => 'appuser',
-    proxy         => 'http://proxy.domain.com:3128',
-    environment   => 'ORACLE_HOME=/usr/lib/oracle/11.2/client64',
-    install_args  => '-e',
-    timeout       => 1800,
-   }
-```
-*Install Requests with pip3*
-```puppet
-  python::pip { 'requests' :
-    ensure        => 'present',
-    pkgname       => 'requests',
-    pip_provider  => 'pip3',
-    virtualenv    => '/var/www/project1',
-    owner         => 'root',
-    timeout       => 1800
-  }
-```
-
-### python::requirements
-
-Installs and manages Python packages from requirements file.
-
-**virtualenv** - virtualenv to run pip in. Default: system-wide
-
-**proxy** - Proxy server to use for outbound connections. Default: none
-
-**owner** - The owner of the virtualenv to ensure that packages are installed with the correct permissions (must be specified). Default: root
-
-**src** - The `--src` parameter to `pip`, used to specify where to install `--editable` resources; by default no `--src` parameter is passed to `pip`.
-
-**group** - The group that was used to create the virtualenv.  This is used to create the requirements file with correct permissions if it's not present already.
-
-**manage_requirements** - Create the requirements file if it doesn't exist. Default: true
-
-```puppet
-  python::requirements { '/var/www/project1/requirements.txt' :
-    virtualenv => '/var/www/project1',
-    proxy      => 'http://proxy.domain.com:3128',
-    owner      => 'appuser',
-    group      => 'apps',
-  }
-```
-
-### python::virtualenv
-
-Creates Python virtualenv.
-
-**ensure** - present/absent. Default: present
-
-**version** - Python version to use. Default: system default
-
-**requirements** - Path to pip requirements.txt file. Default: none
-
-**systempkgs** - Copy system site-packages into virtualenv. Default: don't
-
-**venv_dir** - The location of the virtualenv if resource path not specified. Must be absolute path. Default: resource name
-
-**ensure_venv_dir** - Create virtualenv directory. Default: true
-
-**distribute** - Include distribute in the virtualenv. Default: true
-
-**index** - Base URL of Python package index. Default: none
-
-**owner** - Specify the owner of this virtualenv
-
-**group** - Specify the group for this virtualenv
-
-**mode** - Specify the directory mode. Default: 0755
-
-**proxy** - Proxy server to use for outbound connections. Default: none
-
-**environment** - Additional environment variables required to install the packages. Default: none
-
-**path** - Set the $PATH environment variable. Default: [ '/bin', '/usr/bin', '/usr/sbin' ]
-
-**cwd** - The directory from which to run the "pip install" command. Default: undef
-
-**timeout** - The maximum time in seconds the "pip install" command should take. Default: 1800
-
-**pip_args** - Arguments to pass to pip during installation. Default: blank
-
-**extra_pip_args** - Arguments to pass to pip for package install.  These are included in the pip command *after* the requirements file.  Default: blank
-
-```puppet
-  python::virtualenv { '/var/www/project1' :
-    ensure          => present,
-    version         => 'system',
-    requirements    => '/var/www/project1/requirements.txt',
-    systempkgs      => true,
-    venv_dir        => '/home/appuser/virtualenvs',
-    ensure_venv_dir => false,
-    distribute      => false,
-    index           => 'appuser',
-    owner           => 'appuser',
-    group           => 'apps',
-    proxy           => 'http://proxy.domain.com:3128',
-    cwd             => '/var/www/project1',
-    timeout         => 0,
-    extra_pip_args  => '--no-binary :none:',
-  }
-```
-
-### python::pyvenv
-
-Creates Python3 virtualenv.
-
-**ensure** - present/absent. Default: present
-
-**version** - Python version to use. Default: system default
-
-**systempkgs** - Copy system site-packages into virtualenv. Default: don't
-
-**venv_dir** - The location of the virtualenv if resource path not specified. Must be absolute path. Default: resource name
-
-**owner** - Specify the owner of this virtualenv
-
-**group** - Specify the group for this virtualenv
-
-**path** - Specifies the PATH variable that contains `pyvenv` executable. Default: [ '/bin', '/usr/bin', '/usr/sbin' ]
-
-**environment** - Specify any environment variables to use when creating pyvenv
-
-```puppet
-  python::pyvenv { '/var/www/project1' :
-    ensure       => present,
-    version      => 'system',
-    systempkgs   => true,
-    venv_dir     => '/home/appuser/virtualenvs',
-    owner        => 'appuser',
-    group        => 'apps',
-  }
-```
-
-### python::gunicorn
-
-Manages Gunicorn virtual hosts.
-
-**ensure** - present/absent. Default: present
-
-**virtualenv** - Run in virtualenv, specify directory. Default: disabled
-
-**mode** - Gunicorn mode. wsgi/django. Default: wsgi
-
-**dir** - Application directory.
-
-**bind** - Bind on: 'HOST', 'HOST:PORT', 'unix:PATH'. Default: `unix:/tmp/gunicorn-$name.socket` or `unix:${virtualenv}/${name}.socket`
-
-**environment** - Set ENVIRONMENT variable. Default: none
-
-**appmodule** - Set the application module name for gunicorn to load when not using Django. Default: `app:app`
-
-**osenv** - Allows setting environment variables for the gunicorn service. Accepts a hash of 'key': 'value' pairs. Default: false
-
-**timeout** - Allows setting the gunicorn idle worker process time before being killed. The unit of time is seconds. Default: 30
-
-**template** - Which ERB template to use. Default: python/gunicorn.erb
-
-```puppet
-  python::gunicorn { 'vhost' :
-    ensure      => present,
-    virtualenv  => '/var/www/project1',
-    mode        => 'wsgi',
-    dir         => '/var/www/project1/current',
-    bind        => 'unix:/tmp/gunicorn.socket',
-    environment => 'prod',
-    appmodule   => 'app:app',
-    osenv       => { 'DBHOST' => 'dbserver.example.com' },
-    timeout     => 30,
-    template    => 'python/gunicorn.erb',
-  }
-```
-
-### python::dotfile
-
-Manages arbitrary python dotiles with a simple config hash.
-
-**ensure** - present/absent. Default: present
-
-**filename** - Default: $title
-
-**mode** - Default: 0644
-
-**owner** - Default: root
-
-**group** - Default: root
-
-**config** Config hash. This will be expanded to an ini-file. Default: {}
-
-```puppet
-python::dotfile { '/var/lib/jenkins/.pip/pip.conf':
-  ensure => present,
-  owner  => 'jenkins',
-  group  => 'jenkins',
-  config => {
-    'global' => {
-      'index-url       => 'https://mypypi.acme.com/simple/'
-      'extra-index-url => https://pypi.risedev.at/simple/
-    }
-  }
-}
+For class usage refer to the <a href="https://github.com/voxpupuli/puppet-python/blob/master/REFERENCE.md">REFERENCE.md</a>. If contributing, this is updated with
+```shell
+bundle exec rake strings:generate\[',,,,false,true']
 ```
 
 ### hiera configuration