Metadata-Version: 2.1
Name: naxxatrapy
Version: 1.0.1
Summary: Read the latest Real Python tutorials
Home-page: https://github.com/naxxatra/naxxatrapy
Author: Naxxatra Sciences
Author-email: contact@naxxatra.com
License: MIT
Description: python-package-boilerplate
        ==========================
        
        [![Build Status](https://travis-ci.com/naxxatra/naxxatrapy.svg?branch=master)](https://travis-ci.com/naxxatra/naxxatrapy)
        [![Requires.io](https://requires.io/github/mtchavez/python-package-boilerplate/requirements.svg?branch=master)](https://requires.io/github/mtchavez/python-package-boilerplate/requirements?branch=master)
        
        Boilerplate for a Python Package
        
        ## Package
        
        Basic structure of package is
        
        ```
        ├── README.md
        ├── packagename
        │   ├── __init__.py
        │   ├── packagename.py
        │   └── version.py
        ├── pytest.ini
        ├── requirements.txt
        ├── setup.py
        └── tests
            ├── __init__.py
            ├── helpers
            │   ├── __init__.py
            │   └── my_helper.py
            ├── tests_helper.py
            └── unit
                ├── __init__.py
                ├── test_example.py
                └── test_version.py
        ```
        
        ## Requirements
        
        Package requirements are handled using pip. To install them do
        
        ```
        pip install -r requirements.txt
        ```
        
        ## Tests
        
        Testing is set up using [pytest](http://pytest.org) and coverage is handled
        with the pytest-cov plugin.
        
        Run your tests with ```py.test``` in the root directory.
        
        Coverage is ran by default and is set in the ```pytest.ini``` file.
        To see an html output of coverage open ```htmlcov/index.html``` after running the tests.
        
        ## Travis CI
        
        There is a ```.travis.yml``` file that is set up to run your tests for python 2.7
        and python 3.2, should you choose to use it.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
