Python

[rain1024]

I: Make amazing Python happen

Project Structure

├── LICENSE
├── README.md    .
├── module
│   ├── xxx.py
│   ├── yyy.py
│   └── zzz.py
├── requirements.txt
├── docs
│   ├── xxx.rs
│   ├── yyy.rs
│   └── zzz.rs
└── tests
    ├── test-xxx.py
    ├── test-yyy.js
    └── test-zzz.js

II. Do Python right

Documentation	Testing	Package Management	Scaffolding
ReadTheDocs	py.test	pip	Cookiecutter

Package Management:

pip

Install

$ pip $ pip install -r requirements.txt $ cat requirements.txt BeautifulSoup==3.2.0 Django==1.3 Fabric==1.2.0 Jinja2==2.5.5 PyYAML==3.09

Virtual Environments

virtualenv, http://docs.python-guide.org/en/latest/dev/virtualenvs/ A Virtual Environment, put simply, is an isolated working copy of Python which allows you to work on a specific project without worry of affecting other projects. Python Power Tools: virtualenv

Testing

py.test

Runner up

• Unittest

  Comments

# -*- coding: utf-8 -*-
#-------------------------------------------------------------------------------
# Name:        Connect to machine and return connector
# Purpose:
#
# Author:      Brother Rain
#
# Created:     11/04/2014
# Copyright:   (c) Brother Rain 2014
# Licence:     MIT
#-------------------------------------------------------------------------------

Scaffoding

Cookie Cutter, https://github.com/audreyr/cookiecutter-pypackage

Similar

NodeJS

References

• Knupp, J. (2013). Open Sourcing a Python Project the Right Way. [online] Jeffknupp.com. Available at: http://www.jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/ [Accessed 17 Jul. 2014].

[rain1024]

Documentation

sphinx http://sphinx-doc.org/tutorial.html

Runner up

pydoc

Get it

References

• YouTube, (2013). Sphinx & Read the Docs. [online] Available at: https://www.youtube.com/watch?feature=player_embedded&v=oJsUvBQyHBs [Accessed 18 Jul. 2014].
• Livesphinx.herokuapp.com, (2014). Online Sphinx editor. [online] Available at: http://livesphinx.herokuapp.com/ [Accessed 18 Jul. 2014].