Metadata-Version: 1.1
Name: pyossboilerplate
Version: 0.2.0
Summary: Generates boilerplate for open source python projects.
Home-page: https://patrickayoup.github.com/pyoss-boilerplate
Author: Patrick Ayoup
Author-email: patrick.ayoup@gmail.com
License: MIT
Download-URL: https://github.com/patrickayoup/pyoss-boilerplate/tarball/0.2.0
Description: pyoss-boilerplate
        =================
        
        |TravisCI Status|
        |Coveralls Status|
        |Documentation Status|
        |PyPi Package Status|
        
        Boilerplate for starting an open source python project.
        
        Read the documentation at `Read the Docs!`_
        
        Setting Up the Development Environment
        --------------------------------------
        
        The development environment is based on a Centos 7 environment managed
        by Vagrant.
        
        Pre-Requisites
        ~~~~~~~~~~~~~~
        
        -  `Vagrant`_
        -  `ChefDK`_
        
        Once Vagrant and the ChefDK are installed, you must install the
        vagrant-berkshelf plugin for Vagrant which allows the use of Berkshelf
        to manage cookbooks for provisioning the virtual machine, and the
        vagrant-omnibus plugin which installs chef on the vm allowing it to be
        provisioned.
        
        .. code:: bash
        
            vagrant plugin install vagrant-berkshelf
            vagrant plugin install vagrant-omnibus
        
        Create the Development Environment
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        The creation of the development environment is automated by Vagrant.
        Simply run the following:
        
        .. code:: bash
        
            vagrant up
        
        from the root directory of this project.
        
        Once the virtual machine is provisioned, login to the vm:
        
        .. code:: bash
        
            vagrant ssh
        
        Create and activate a virtualenv:
        
        .. code:: bash
        
            mkvirtualenv pyoss-boilerplate
        
        Install the dependencies:
        
        .. code:: bash
        
            pip install -r /vagrant/requirements.txt
        
        .. _Read the Docs!: http://pyoss-boilerplate.readthedocs.org/en/latest/
        .. _Vagrant: http://www.vagrantup.com
        .. _ChefDK: http://downloads.getchef.com/chef-dk/
        
        .. |Documentation Status| image:: https://readthedocs.org/projects/pyoss-boilerplate/badge/?version=latest
           :target: https://readthedocs.org/projects/pyoss-boilerplate/?badge=latest
        
        .. |PyPi Package Status| image:: https://badge.fury.io/py/pyossboilerplate.svg
            :target: http://badge.fury.io/py/pyossboilerplate
        
        .. |TravisCI Status| image:: https://travis-ci.org/patrickayoup/pyoss-boilerplate.svg?branch=master
            :target: https://travis-ci.org/patrickayoup/pyoss-boilerplate
        
        .. |Coveralls Status| image:: https://coveralls.io/repos/patrickayoup/pyoss-boilerplate/badge.png?branch=master
            :target: https://coveralls.io/r/patrickayoup/pyoss-boilerplate?branch=master
        
        
Keywords: open source,boiler plate
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Utilities
