LoginSignup
51

More than 5 years have passed since last update.

自作Pythonライブラリをpipインストール出きるようにするまで

Last updated at Posted at 2016-09-24

Pythonのパッケージ管理について

もっとも簡単にpipによるPythonのパッケージダウンロードができた方法をまとめておきます。
いくつか種類がありますが、setuptoolsを使用しました。

手順

1.サンプルプロジェクトの取得

こちらのサイトからサンプルプロジェクトを取得します。
https://github.com/pypa/sampleproject

2. 配布用パッケージの作成

サンプルプロジェクトのフォルダで
$ python setup.py sdist
を実行

3. 不要ファイルの削除

このフォルダは消しました
・sample
・data
・LISENCE.txt
・xxxxx-egg こんなファイルも消した気が...

4. setup.pyの編集

name= プロジェクトの名前
version=バージョン名
description=説明
long_description= README.rstが参照されるようになっています
url=パッケージが保存してあるサイトのURL githubなど
author=製作者
author_email=製作者のメールアドレス
license=適用するライセンス
packages=配布するパッケージの名称(ライブラリ名)

5. 必要なファイルを保存する

カレントの下に必要なライブラリやサンプルプログラムなどを配置します。
配布するパッケージはパッケージの名称と同じ名前のフォルダに入れてください。

6. ローカルでインストールしてみる

$ python setup.py install
これを実行すると
 プロジェクト名.egg-info
 build
dist
などが生成されました。

サンプルプログラムが問題なく動作すればOK

7. 配布していきます。

最初にやるとき

$ python setup.py register

2回め以降

setup.py内のバージョン情報は変更して、次のコマンドを実行する
$ python setup.py sdist upload

tips

このようなメッセージが出るときは、pypiへの登録ができていません。
Upload failed (401): You must be identified to edit package information

その時はregisterを行いましょう
$ python setup.py register

8. 動作確認

ローカルでインストールしたパッケージを消して動作確認をしてみます。

$ sudo pip uninstall パッケージ名
プロジェクトが保存されていないフォルダに移動
$ sudo pip install パッケージ名

この後、サンプルプログラムを動かしてみて問題なく動作すれば、正しくパッケージがインストールされたということです。

最後に

1. GITHUBのフォルダ

2. 配布したファイル

.
├── MANIFEST.in
├── PyLaz
│   ├── PyLaz.py
│   ├── PyLaz.pyc
│   ├── __init__.py
│   ├── __init__.pyc
│   └── __pycache__
│       ├── PyLaz.cpython-34.pyc
│       └── __init__.cpython-34.pyc
├── PyLaz.egg-info
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   ├── dependency_links.txt
│   └── top_level.txt
├── README.rst
├── build
│   ├── bdist.linux-armv7l
│   ├── docs
│   └── lib.linux-armv7l-2.7
│       └── PyLaz
│           ├── PyLaz.py
│           └── __init__.py
├── dist
│   ├── PyLaz-0.0.1-py2.7.egg
│   └── PyLaz-0.0.1.tar.gz
├── samples
│   ├── rxsample.py
│   └── txsample.py
├── setup.cfg
├── setup.py
├── tests
│   ├── __init__.py
│   └── test_simple.py
└── tox.ini

3. setup.pyの中身

"""A setuptools based setup module.

See:
https://packaging.python.org/en/latest/distributing.html
https://github.com/pypa/sampleproject
"""

# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path

here = path.abspath(path.dirname(__file__))

# Get the long description from the README file
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
    long_description = f.read()

setup(
    name='PyLaz',

    # Versions should comply with PEP440.  For a discussion on single-sourcing
    # the version across setup.py and the project code, see
    # https://packaging.python.org/en/latest/single_source_version.html
    version='0.0.2',

    description='Python Library for Lazurite',
    long_description=long_description,

    # The project's main homepage.
    url='https://github.com/LAPIS-Lazurite/PyLaz',

    # Author details
    author='lapis semiconductor',
    author_email='lazurite@adm.lapis-semi.com',

    # Choose your license
    license='MIT',

    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
    classifiers=[
        # How mature is this project? Common values are
        #   3 - Alpha
        #   4 - Beta
        #   5 - Production/Stable
        'Development Status :: 4 - Beta',

        # Indicate who your project is intended for
        'Intended Audience :: Developers',
        'Topic :: Software Development :: Build Tools',

        # Pick your license as you wish (should match "license" above)
        'License :: OSI Approved :: MIT License',

        # Specify the Python versions you support here. In particular, ensure
        # that you indicate whether you support Python 2, Python 3 or both.
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.6',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.3',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
    ],

    # What does your project relate to?
    keywords='Python library for Lazurite',

    # You can just specify the packages manually here if your project is
    # simple. Or you can use find_packages().
    #packages=find_packages(exclude=['contrib', 'docs', 'tests']),
    packages=['PyLaz'],

    # Alternatively, if you want to distribute just a my_module.py, uncomment
    # this:
    #   py_modules=["my_module"],

    # List run-time dependencies here.  These will be installed by pip when
    # your project is installed. For an analysis of "install_requires" vs pip's
    # requirements files see:
    # https://packaging.python.org/en/latest/requirements.html
    #install_requires=['peppercorn'],

    # List additional groups of dependencies here (e.g. development
    # dependencies). You can install these using the following syntax,
    # for example:
    # $ pip install -e .[dev,test]
    #extras_require={
        #'dev': ['check-manifest'],
        #'test': ['coverage'],
    #},

    # If there are data files included in your packages that need to be
    # installed, specify them here.  If using Python 2.6 or less, then these
    # have to be included in MANIFEST.in as well.
    #package_data={
        #'sample': ['package_data.dat'],
    #},

    # Although 'package_data' is the preferred approach, in some case you may
    # need to place data files outside of your packages. See:
    # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files # noqa
    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
    #data_files=[('my_data', ['data/data_file'])],

    # To provide executable scripts, use entry points in preference to the
    # "scripts" keyword. Entry points provide cross-platform support and allow
    # pip to create the appropriate form of executable for the target platform.
    #entry_points={
        #'console_scripts': [
            #'sample=sample:main',
        #],
    #},
)

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
51