Python で pip でインストール出来る CLI ツールを作成する

Python で pip でインストール出来る CLI ツールを作成する手順をメモしておきます。

ディレクトリ構成

今回は以下のディレクトリ構成にしました。

my-first-cli/
├── module
│   └── main.py
├── setup.cfg
└── setup.py

各ファイルの中身は以下の通りです。

my-first-cli/module/main.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-

def main():
    print("Hello World!")

my-first-cli/setup.py

#!/usr/bin/env python
# -*- coding:utf-8 -*-

from setuptools import setup

setup()

my-first-cli/setup.cfg

[metadata]
name = my-first-cli
version = 0.0.1

[options.entry_points]
console_scripts =
  my-first-cli = module.main:main

ローカルからのインストール

pip でインストール可能です。

python3 -m pip install -e ~/my-first-cli/

実行すると setup.cfg の entry_points の定義に従い、Python スクリプトが実行されました。

# my-first-cli
Hello World!