Distribution

Quick

Directory structure

Project
  ├── bin
  │   ├── script1.py
  │   └── script2.py
  |
  ├── docs
  │   ├── example.txt
  │   └── background.md
  |
  ├── extra_files
  │   ├── ef1.txt
  │   └── ef2.txt
  |
  ├── CHANGES.txt
  ├── LICENSE.txt
  ├── MANIFEST.in
  ├── README.md
  ├── setup.py
  |
  └── module
      |
      ├── module.py
      ├── __init__.py
      |
      ├── data
      │   └── data.csv
      |
      └── test
          ├── __init__.py
          ├── test_method1.py
          └── test_method2.py

Changes.txt

# version, date, notes
v0.1.0, 20150123, Initial release
v0.1.1, 20150123, Minor updates

License.txt

MIT License

Copyright (c) [year] [fullname]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Minifest.in

include *.txt
include *.md
recursive-include extra_files *.txt
recursive-include docs *.txt   
recursive-include docs *.md    
recursive-include bin *.py

Readme.md

Title
Installation
Usage
Contributors

Setup.py

from setuptools import setup

setup(
    # Package details
    name = "module",
    version = "0.1.1",
    packages = ['module'],

    # Project details
    author = "Ray",
    author_email = "[email protected]",
    description = "Tools for manipulating vowels in a sentence",
    keywords = ["english","vowels"],
    url = "", # project home page

    # Add license type
    license = "MIT",
    data_files = [('', ['LICENSE.txt'])],

    # Help documentation
    long_description = open('README.txt').read(),
    install_requires = ['logging'],

    # Include static files:
    include_package_data = True,

    # Include package data
    package_data = {'module': ['data/*.csv']},

    # Include bin scripts
    scripts = ['bin/script1.py', 'bin/script2.py'],

    # Trove classifiers for uploading to PyPI
    classifiers = [
        'Development Status :: 3 - Alpha',
        'Natural Language :: English',
        'Programming Language :: Python :: 2.7',
    ],      
)

__init.py__

# empty