Python ライブラリを構築してデプロイする方法

ソフトウェア開発では、多くのプロジェクトに同一のコードとロジックを使用した反復的なタスクが含まれます。 プログラマはこのコードを常に書き換えるので、非効率が生じます。 例には、電子メールの検証やランダムな文字列の生成が含まれます。

解決策は、このコードを再利用可能なライブラリにパッケージ化することです。これらのライブラリはプロジェクト全体にインストールされて使用されるため、冗長なコーディングが排除されます。 ほとんどはオープンソースであり、無料で利用できます。

これは、Python や JavaScript などの言語では標準的な方法です。 このチュートリアルでは、Python ライブラリを構築して、公式 Python パッケージ リポジトリである PyPI にデプロイする方法について詳しく説明します。

プロジェクト概要

このチュートリアルでは、REST API と対話するオープンソース Python ライブラリの作成とデプロイについて説明します。

Python ライブラリ

ライブラリは、Abstract API の為替レート REST API をラップします。 この API は 3 つのエンドポイントを提供します:

• /live: 現在の為替レートを取得します。
• /convert: 通貨間で金額を変換します (例: 5 USD から GBP)。
• /historical: 指定された期間の過去の為替レートを取得します。

このライブラリは、開発者向けの API 対話を簡素化します。

プロジェクト要件

このチュートリアルは、オブジェクト指向プログラミング (OOP) や関数の使用法など、Python コーディングの熟練度を前提としています。 Git、GitHub リポジトリ、プロジェクトのプッシュに関する知識も必要です。

ツールとパッケージ

必要なもの:

• Python: インタプリタ (>=3.9)。
• リクエスト: HTTP リクエストを行うため。
• 抽象 API アカウント: API キーを取得します (手順が提供されます)。
• Dotenv: 環境変数の管理用。
• 詩: Python の依存関係管理およびパッケージ化ツール。

プロジェクトの作成

1. プロジェクト ディレクトリを作成します:

   <code class="language-bash">mkdir exchangeLibrary</code>

2. virtualenv をインストールします (まだインストールされていない場合):

   <code class="language-bash">pip install virtualenv</code>

3. プロジェクト ディレクトリに移動します:

   <code class="language-bash">cd exchangeLibrary</code>

4. 仮想環境を作成してアクティブ化します:

   <code class="language-bash">virtualenv env</code>

   アクティブ化 (Windows): .envScriptsactivate アクティブ化 (Linux/macOS): source env/bin/activate

5. 必要なパッケージをインストールします:

   <code class="language-bash">pip install requests poetry dotenv</code>

6. コード エディター (PyCharm/VS Code) でプロジェクトを開きます。

プロジェクト リソースのセットアップ

1. src ディレクトリを作成します。 中に、exchange_python と __init__.py を含む exchange.py を作成します。 構造は以下の画像のようになるはずです:

   

2. 単体テスト用の test.py を作成します。

3. 抽象 API キーを取得します: ａ．抽象 API にサインアップします。 b.ログイン。 c.為替レート API に移動します。 d.主キーを取得します。

4. .env ファイルを作成します: API キーを追加します:

   <code class="language-bash">mkdir exchangeLibrary</code>

   構造は次のようになります:

API ラッパーのビルド (exchange.py)

<code class="language-bash">pip install virtualenv</code>

(live、historical、および convert メソッドは元の入力での説明のままです。)

API ラッパーのテスト (test.py)

1. __init__.py:

   <code class="language-bash">cd exchangeLibrary</code>

2. test.py:

   <code class="language-bash">virtualenv env</code>

3. テストを実行します: 成功したテスト結果が表示されるはずです。

プロジェクトのデプロイ

1. .gitignore ファイルを作成します: env、.env を追加します。

2. README.md ファイルを作成します。

3. pyproject.toml:

   を作成します

   <code class="language-bash">pip install requests poetry dotenv</code>

4. GitHub リポジトリを作成します。

5. Git の初期化: git init

6. リモートを追加: git remote add origin <your github repo>

7. pyproject.toml を GitHub リポジトリ URL で更新します。

8. GitHub にプッシュします。

PyPI へのデプロイ

1. PyPI アカウントを作成し、メールアドレスを確認します。
2. 2FA を設定します。
3. リカバリー コードを生成します。
4. 認証アプリを使用して QR コードをスキャンします。
5. API トークンを取得します。
6. パッケージをビルドします: poetry build
7. PyPI トークンを設定します: poetry config pypi-token.pypi <your-api-token>
8. 公開: poetry publish

プロジェクトのメンテナンス

更新後、変更を GitHub にプッシュし、ビルド (poetry build) して再公開 (poetry publish) し、必要に応じて pyproject.toml のバージョンを更新します。

インストールと使用法

<code class="language-bash">mkdir exchangeLibrary</code>

<code class="language-bash">pip install virtualenv</code>

結論

このチュートリアルでは、Python ライブラリの構築と PyPI へのデプロイ (更新と再公開を含む) について説明しました。 オープンソース コミュニティへの貢献は、Python 開発の改善に役立ちます。

以上がPython ライブラリを構築してデプロイする方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。