備忘録：python Skeleton ニャ

おおよそ元ネタ

私の場合のプロジェクトスケルトン

忘れるので、自分用 python プロジェクト構築手順

前提条件

以下のものがインストール前提

• pip
• virtualenv
• pythonz

1. プロジェクト用環境構築

必要場合は python 環境を構築する

# 必要な場合 python をインストール
$ pythonz install py_version

# vritualenv 環境構築
$ cd path_to_virtualenv_dir
$ virtualenv -p `pythonz locate py_version` virtualenv_dir_name

# pythonz インストール内容確認
$ pythonz list
# virtualenv activate
$ . path_to_virtualenv_dir/virtualenv_dir_name/bin/activate
# virtualenv deactivate
$ deactivate

2. ディレクトリ作成

# python プロジェクト格納ディレクトリ
$ mkdir projects
# プロジェクトディレクト作成
$ mkdir prj_name ; cd prj_name
# 初期化
$ mkdir bin pkg_name test docs
touch pkg_name/__init__.py tests/__init__.py

3. setup.py

以下のファイルを prj_name/setup.py　に作成する

try:
    from setuptools import setup
except ImportError:
    from distutils.core import setup

config = {
    'description': 'My Project',
    'author': 'My Name',
    'url': 'URL to get it at.',
    'download_url': 'Where to download it.',
    'author_email': 'My email.',
    'version': '0.1',
    'install_requires': ['nose'],
    'packages': ['NAME'],
    'scripts': [],
    'name': 'projectname'
}

setup(**config)

install_requires にある依存ライブラリをセットアップ

$ python setup.py develop
# 確認
$ pip list

4. テスト環境を用意

prj_name/tests/pkg_name_tests.py にテストを追加

from nose.tools import *
import pkg_name

def setup():
    print "SETUP!"

def teardown():
    print "TEAR DOWN!"

def test_basic():
    print "I RAN!"

動作確認

$ nosetest

5. ディレクトリ構造

ディレクトリ構造下記のようになります

prj_name/
     pkg_name/
         __init__.py
     bin/
     docs/
     setup.py
     tests/
         pkg_name_tests.py
         __init__.py