PythonプログラミングにおけるShivの利用方法についてですが、まずはプロジェクトの構成を理解しておくことが重要です。ShivはあなたのPythonコードを`.pyz`ファイルという形にパッケージ化します。これは自己実行型プログラムのようなもので、正しく機能させるためには特定のファイル配置が求められます。この過程では、必要なライブラリや依存関係も含まれるため、異なる環境で実行する際にも安心です。また、エントリーポイントや使用するPythonバージョンを指定できるオプションもあり、それによって最適化されたパッケージが作成可能です。
あなたのアプリケーションは、少なくとも次のような構造を持つべきです。
myapp/
├── myapp/
│ ├── __init__.py
│ └── __main__.py
├── <a href="https://shivlab.com/blog/how-to-create-a-python-package/" target="_blank" class="blogHightLight_css nobox">setup.py</a>
└── requirements.txt (オプション)
この構造が整ったら、Shiv がアプリを起動するためのエントリーポイントを定義し始めることができます。以下のポイントに注目してみましょう。まず、内側の `myapp` ディレクトリは有効な Python パッケージである必要があります。つまり、`__init__.py` ファイルが含まれている必要があります。また、Shiv はコマンドラインエントリとして機能する呼び出し可能な関数（通常は `main` という名前）を利用します。この関数は `__main__.py` に配置されており、zipapp のデフォルトエントリとしても機能しますし、`setup.py` 内の `console_scripts` の期待にも応える形となります。このようにして、異なるコマンドラインインターフェースや GUI アプリケーションへの拡張性を持たせることができ、多様な機能を同一パッケージ内で提供することが可能になります。
Shivを使う場合、`setup.py`を使用しなくても、アプリケーションを`__main__.py`から直接起動することができます。Pythonのzipappは特定の規則に従っており、実行時にはアーカイブのルートにある`__main__.py`ファイルを探して、それを実行します。この仕組みを利用して、Shivも同様に動作します。つまり、あなたの`.pyz`ファイルに`__main__.py`が含まれていれば、コマンド `python myapp.pyz` で自己実行可能になり、Unix系システムでは実行可能ファイルとして設定することもできます。ただし、適切なエントリーポイントを `setup.py` で定義することで、プロジェクトの配布や再利用性が高まります。特にpip経由で配布したい場合には、この方法が効果的です。Shivは比較的手軽に使えますが、そのためにはまずプロジェクトが機能する状態であることが重要です。
### ステップ1: エントリーポイントを定義する
Shivを利用するには、アプリケーションが起動したときに実行する関数を指定する必要があります。これは、`setup.py`内で`console_scripts`エントリポイントを設定することで実現します。具体的には、コマンド（例えば `myapp`）と特定のPython関数（例： `myapp.__main__:main`）を対応付けます。以下はその一例です。
from setuptools import setup, find_packages
setup(
name="myapp",
version="0.1",
packages=find_packages(),
entry_points={
'console_scripts': [
'myapp = myapp.__main__:main'
]
},
install_requires=[
# ここに依存関係を記載するか、requirements.txtを使用してください
],
)
# myapp/__main__.py
def main():
print("ShivパワーのCLIへようこそ！")
このファイルは、Pythonのzipアプリ（Shivを含む）が実行可能なアーカイブとして認識されるために必要です。この設定を忘れたり、エントリポイントが正しく構成されていない場合、`.pyz`ファイルは正常にビルドされますが、正しくは動作しません。モジュールの構造がきちんとしていてインポート可能であることを確認してください。もしパッケージが適切に宣言されていなかったり、モジュールが見つからないと、Shivはランタイム時に`ImportError`や`AttributeError`で失敗することになります。
Shivを使って実行可能なパッケージを作成します。以下のコマンドを実行してください。
shiv -c myapp -o myapp.pyz -p "/usr/bin/env python3" .
`requirements.txt`ファイルからビルドするためには、次のようにコマンドを実行します。
-c myapp -o myapp.pyz -r requirements.txt .+x myapp.pyz./myapp.pyzWindowsでは、単に
myapp.pyz
オプション1: `.bat`ファイルを使用する
`launch_myapp.bat`というファイルを作成します:
@echo off
python myapp.pyz %*
# launcher.py
import runpy
runpy.run_path("myapp.pyz", run_name="__main__")
pip install pyinstaller
pyinstaller --onefile launcher.py
