pylogiless 0.1.0__tar.gz

pylogiless-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 LOGILESS API Python Client Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pylogiless-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include requirements.txt
+recursive-include docs *
+recursive-include tests *

pylogiless-0.1.0/PKG-INFO

@@ -0,0 +1,311 @@
+Metadata-Version: 2.1
+Name: pylogiless
+Version: 0.1.0
+Summary: Python client for the LOGILESS API
+Home-page: https://github.com/logiless/pylogiless
+Author: LOGILESS API Python Client Contributors
+Author-email: contact@logiless.jp
+Project-URL: Bug Tracker, https://github.com/logiless/pylogiless/issues
+Project-URL: Documentation, https://github.com/logiless/pylogiless/blob/main/docs
+Project-URL: Source Code, https://github.com/logiless/pylogiless
+Keywords: logiless,api,logistics,inventory,warehouse
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Documentation for Logiless API
+
+このリポジトリにはLogiless APIに関するドキュメントとPython用クライアントライブラリ「pylogiless」が含まれています。
+
+## pylogiless - Python クライアントライブラリ
+
+ロジレスAPIにPythonからアクセスするためのクライアントライブラリです。このライブラリを使用することで、Pythonアプリケーションから簡単にLOGILESS APIにアクセスすることができます。
+
+### インストール
+
+```bash
+pip install pylogiless
+```
+
+### 使用方法
+
+#### 初期化と認証
+
+```python
+from pylogiless import LogilessClient
+
+# クライアントの初期化
+client = LogilessClient(
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+    redirect_uri="YOUR_REDIRECT_URI"
+)
+
+# 認証URLの取得
+auth_url = client.get_authorization_url()
+print(f"次のURLにアクセスして認証してください: {auth_url}")
+
+# コールバックで取得した認可コードを使用してトークンを取得
+code = "AUTHORIZATION_CODE"  # ユーザーが認証後に取得した認可コード
+client.fetch_token(code)
+
+# または、既存のアクセストークンとリフレッシュトークンを設定
+client.set_token(access_token="ACCESS_TOKEN", refresh_token="REFRESH_TOKEN")
+```
+
+#### APIの呼び出し例
+
+```python
+# 在庫情報の取得
+inventory = client.actual_inventory_summary.list()
+
+# 出荷配送の情報取得
+outbound_deliveries = client.outbound_delivery.list()
+
+# 商品情報の取得
+article = client.article.get("ARTICLE_ID")  # resource_idとして渡す
+
+# 商品情報の作成
+new_article = client.article.create({
+    "article_code": "ARTICLE_CODE",
+    "article_name": "商品名",
+    # その他の必要なパラメータ
+})
+```
+
+### 機能
+
+- OAuth2認証フロー（認可コードフロー）のサポート
+- アクセストークンの自動更新
+- APIエンドポイントへの簡単なアクセス
+- エラーハンドリング
+
+### パッケージ構造
+
+このライブラリは `pylogiless` という名前でインストールされます。標準的なPythonパッケージ構造に従い、以下のようにインポートできます：
+
+```python
+# メインのクライアントと認証クラスは直接インポート可能
+from pylogiless import LogilessClient, LogilessAuth
+
+# 特定のエラークラスが必要な場合
+from pylogiless import LogilessError, LogilessAuthError
+
+# 内部モジュールに直接アクセスする場合（通常は不要）
+from pylogiless.api import client, auth, errors
+```
+
+### ドキュメント
+
+詳細なドキュメントは以下のリンクをご覧ください：
+
+- [API リファレンス](docs/api_reference.md) - 各APIエンドポイントの詳細な使い方
+- [認証ガイド](docs/authentication.md) - OAuth2認証フローの詳細
+- [エラーハンドリングガイド](docs/error_handling.md) - エラー処理の方法
+- [サンプルコード](docs/example.py) - 基本的な使用例
+
+より詳しいドキュメントは[GitHubリポジトリ](https://github.com/logiless/pylogiless)でご確認いただけます。
+
+### 依存関係
+
+このパッケージは以下の依存関係があります：
+
+```
+requests>=2.25.0
+```
+
+### ライセンスと免責事項
+
+- MITライセンスの下で公開されています。詳細は[LICENSE](LICENSE)ファイルをご覧ください。
+- このパッケージは、株式会社ロジレスの公式APIクライアントではありません。ロジレスおよびLOGILESSは株式会社ロジレスの登録商標です。
+
+## APIドキュメント
+
+以下は各Markdownファイルの説明と役割です。
+
+### ファイル一覧
+
+#### docsフォルダ
+
+1. [**authentication.md**](docs/authentication.md)
+
+   - 認証と認可に関する情報が記載されています。
+   - アプリケーションの登録方法や認可コードの取得、アクセストークンの交換手順が詳述されています。
+
+2. [**specifications.md**](docs/specifications.md)
+
+   - APIの仕様に関する情報が記載されています。
+   - エンドポイントやデータフォーマットの詳細を含みます。
+
+3. [**errors.md**](docs/errors.md)
+
+   - エラーメッセージおよびエラーコードに関する情報が記載されています。
+   - 各エラーコードの説明やレスポンス形式が詳述されています。
+
+#### interfaceフォルダ
+
+- [**actual_inventory_summary.md**](interface/actual_inventory_summary.md)
+
+  - 実際の在庫サマリに関する情報を提供します。
+
+- [**location.md**](interface/location.md)
+
+  - ロケーション情報の管理について記載されています。
+
+- [**outbound_delivery.md**](interface/outbound_delivery.md)
+
+  - 出荷配送に関する情報を提供します。
+
+- [**inbound_delivery.md**](interface/inbound_delivery.md)
+
+  - 入荷配送に関する情報を提供します。
+
+- [**reorder_point.md**](interface/reorder_point.md)
+
+  - 再注文点の設定や管理に関する情報を提供します。
+
+- [**article.md**](interface/article.md)
+
+  - 商品情報の管理に関する情報を提供します。
+
+- [**inter_warehouse_transfer.md**](interface/inter_warehouse_transfer.md)
+
+  - 倉庫間移動に関する情報を提供します。
+
+- [**transaction_log.md**](interface/transaction_log.md)
+
+  - 取引ログの記録に関する情報を提供します。
+
+- [**supplier.md**](interface/supplier.md)
+
+  - サプライヤー情報の管理に関する情報を提供します。
+
+- [**article_map.md**](interface/article_map.md)
+
+  - 商品マッピングに関する情報を提供します。
+
+- [**logical_inventory_summary.md**](interface/logical_inventory_summary.md)
+
+  - 論理的な在庫サマリについて記載されています。
+
+- [**store.md**](interface/store.md)
+
+  - 店舗情報の管理について記載されています。
+
+- [**sales_order.md**](interface/sales_order.md)
+
+  - 受注情報の管理について記載されています。
+
+- [**warehouse.md**](interface/warehouse.md)
+
+  - 倉庫情報の管理について記載されています。
+
+- [**daily_inventory_summary.md**](interface/daily_inventory_summary.md)
+
+  - 日次在庫サマリに関する情報を提供します。
+
+#### document_statusフォルダ
+
+- [**delivery_status.md**](type/delivery_status.md)
+
+  - 配送ステータスに関する情報を提供します。
+
+- [**authorization_status.md**](type/authorization_status.md)
+
+  - 認証ステータスに関する情報を提供します。
+
+- [**document_status.md**](type/document_status.md)
+
+  - ドキュメントのステータス管理について記載されています。
+
+- [**article_type.md**](type/article_type.md)
+
+  - 商品タイプに関する情報を提供します。
+
+- [**inbound_delivery_status.md**](type/inbound_delivery_status.md)
+
+  - 入荷配送ステータスについて記載されています。
+
+- [**incoming_payment_status.md**](type/incoming_payment_status.md)
+
+  - 受領済み支払いのステータスに関する情報を提供します。
+
+- [**tax_rounding_method.md**](type/tax_rounding_method.md)
+
+  - 税金の丸め方法について記載されています。
+
+- [**delivery_method.md**](type/delivery_method.md)
+
+  - 配送方法に関する情報を提供します。
+
+- [**document_line_status.md**](type/document_line_status.md)
+
+  - ドキュメント行のステータスについて記載されています。
+
+- [**tax_processing_method.md**](type/tax_processing_method.md)
+
+  - 税金処理の方法について記載されています。
+
+- [**temperature_control.md**](type/temperature_control.md)
+
+  - 温度管理に関する情報を提供します。
+
+- [**payment_method.md**](type/payment_method.md)
+
+  - 支払い方法に関する情報を提供します。
+
+- [**inbound_delivery_category.md**](type/inbound_delivery_category.md)
+
+  - 入荷配送カテゴリに関する情報を提供します。
+
+- [**tax_indicator.md**](type/tax_indicator.md)
+
+  - 税金インジケーターについて記載されています。
+
+- [**express_type.md**](type/express_type.md)
+
+  - エクスプレス配送のタイプについて記載されています。
+
+- [**transaction_type.md**](type/transaction_type.md)
+
+  - 取引タイプに関する情報を提供します。
+
+- [**inventory_summary_layer.md**](type/inventory_summary_layer.md)
+
+  - 在庫サマリレイヤーについて記載されています。
+
+## リンクについて
+
+ファイル間リンクや外部リンクは以下の通り修正されています：
+
+- `/developer/documents/*` へのリンクは該当するMarkdownファイルへの相対リンクに変更。
+- その他のリンクはLogilessの公式URLに変更。
+
+## 使用方法
+
+1. このリポジトリをクローンします。
+
+   ```bash
+   git clone https://github.com/solahsoyalp/LOGILESS_API_Docs_Unofficial.git
+   ```
+
+2. 各Markdownファイルを開き、必要な情報を確認してください。
+
+## 貢献
+
+- APIドキュメントに関する修正や改善案がある場合、Pull Requestを歓迎します。
+- バグ報告や機能リクエストは[GitHub Issues](https://github.com/logiless/pylogiless/issues)にてお願いします。
+
+## 著作権および免責
+
+このファイルは公式APIドキュメント（<https://app2.logiless.com/developer/>）をMarkdown形式にまとめたものです。著作権は全て株式会社ロジレスに帰属します。

pylogiless-0.1.0/README.md

@@ -0,0 +1,286 @@
+# Documentation for Logiless API
+
+このリポジトリにはLogiless APIに関するドキュメントとPython用クライアントライブラリ「pylogiless」が含まれています。
+
+## pylogiless - Python クライアントライブラリ
+
+ロジレスAPIにPythonからアクセスするためのクライアントライブラリです。このライブラリを使用することで、Pythonアプリケーションから簡単にLOGILESS APIにアクセスすることができます。
+
+### インストール
+
+```bash
+pip install pylogiless
+```
+
+### 使用方法
+
+#### 初期化と認証
+
+```python
+from pylogiless import LogilessClient
+
+# クライアントの初期化
+client = LogilessClient(
+    client_id="YOUR_CLIENT_ID",
+    client_secret="YOUR_CLIENT_SECRET",
+    redirect_uri="YOUR_REDIRECT_URI"
+)
+
+# 認証URLの取得
+auth_url = client.get_authorization_url()
+print(f"次のURLにアクセスして認証してください: {auth_url}")
+
+# コールバックで取得した認可コードを使用してトークンを取得
+code = "AUTHORIZATION_CODE"  # ユーザーが認証後に取得した認可コード
+client.fetch_token(code)
+
+# または、既存のアクセストークンとリフレッシュトークンを設定
+client.set_token(access_token="ACCESS_TOKEN", refresh_token="REFRESH_TOKEN")
+```
+
+#### APIの呼び出し例
+
+```python
+# 在庫情報の取得
+inventory = client.actual_inventory_summary.list()
+
+# 出荷配送の情報取得
+outbound_deliveries = client.outbound_delivery.list()
+
+# 商品情報の取得
+article = client.article.get("ARTICLE_ID")  # resource_idとして渡す
+
+# 商品情報の作成
+new_article = client.article.create({
+    "article_code": "ARTICLE_CODE",
+    "article_name": "商品名",
+    # その他の必要なパラメータ
+})
+```
+
+### 機能
+
+- OAuth2認証フロー（認可コードフロー）のサポート
+- アクセストークンの自動更新
+- APIエンドポイントへの簡単なアクセス
+- エラーハンドリング
+
+### パッケージ構造
+
+このライブラリは `pylogiless` という名前でインストールされます。標準的なPythonパッケージ構造に従い、以下のようにインポートできます：
+
+```python
+# メインのクライアントと認証クラスは直接インポート可能
+from pylogiless import LogilessClient, LogilessAuth
+
+# 特定のエラークラスが必要な場合
+from pylogiless import LogilessError, LogilessAuthError
+
+# 内部モジュールに直接アクセスする場合（通常は不要）
+from pylogiless.api import client, auth, errors
+```
+
+### ドキュメント
+
+詳細なドキュメントは以下のリンクをご覧ください：
+
+- [API リファレンス](docs/api_reference.md) - 各APIエンドポイントの詳細な使い方
+- [認証ガイド](docs/authentication.md) - OAuth2認証フローの詳細
+- [エラーハンドリングガイド](docs/error_handling.md) - エラー処理の方法
+- [サンプルコード](docs/example.py) - 基本的な使用例
+
+より詳しいドキュメントは[GitHubリポジトリ](https://github.com/logiless/pylogiless)でご確認いただけます。
+
+### 依存関係
+
+このパッケージは以下の依存関係があります：
+
+```
+requests>=2.25.0
+```
+
+### ライセンスと免責事項
+
+- MITライセンスの下で公開されています。詳細は[LICENSE](LICENSE)ファイルをご覧ください。
+- このパッケージは、株式会社ロジレスの公式APIクライアントではありません。ロジレスおよびLOGILESSは株式会社ロジレスの登録商標です。
+
+## APIドキュメント
+
+以下は各Markdownファイルの説明と役割です。
+
+### ファイル一覧
+
+#### docsフォルダ
+
+1. [**authentication.md**](docs/authentication.md)
+
+   - 認証と認可に関する情報が記載されています。
+   - アプリケーションの登録方法や認可コードの取得、アクセストークンの交換手順が詳述されています。
+
+2. [**specifications.md**](docs/specifications.md)
+
+   - APIの仕様に関する情報が記載されています。
+   - エンドポイントやデータフォーマットの詳細を含みます。
+
+3. [**errors.md**](docs/errors.md)
+
+   - エラーメッセージおよびエラーコードに関する情報が記載されています。
+   - 各エラーコードの説明やレスポンス形式が詳述されています。
+
+#### interfaceフォルダ
+
+- [**actual_inventory_summary.md**](interface/actual_inventory_summary.md)
+
+  - 実際の在庫サマリに関する情報を提供します。
+
+- [**location.md**](interface/location.md)
+
+  - ロケーション情報の管理について記載されています。
+
+- [**outbound_delivery.md**](interface/outbound_delivery.md)
+
+  - 出荷配送に関する情報を提供します。
+
+- [**inbound_delivery.md**](interface/inbound_delivery.md)
+
+  - 入荷配送に関する情報を提供します。
+
+- [**reorder_point.md**](interface/reorder_point.md)
+
+  - 再注文点の設定や管理に関する情報を提供します。
+
+- [**article.md**](interface/article.md)
+
+  - 商品情報の管理に関する情報を提供します。
+
+- [**inter_warehouse_transfer.md**](interface/inter_warehouse_transfer.md)
+
+  - 倉庫間移動に関する情報を提供します。
+
+- [**transaction_log.md**](interface/transaction_log.md)
+
+  - 取引ログの記録に関する情報を提供します。
+
+- [**supplier.md**](interface/supplier.md)
+
+  - サプライヤー情報の管理に関する情報を提供します。
+
+- [**article_map.md**](interface/article_map.md)
+
+  - 商品マッピングに関する情報を提供します。
+
+- [**logical_inventory_summary.md**](interface/logical_inventory_summary.md)
+
+  - 論理的な在庫サマリについて記載されています。
+
+- [**store.md**](interface/store.md)
+
+  - 店舗情報の管理について記載されています。
+
+- [**sales_order.md**](interface/sales_order.md)
+
+  - 受注情報の管理について記載されています。
+
+- [**warehouse.md**](interface/warehouse.md)
+
+  - 倉庫情報の管理について記載されています。
+
+- [**daily_inventory_summary.md**](interface/daily_inventory_summary.md)
+
+  - 日次在庫サマリに関する情報を提供します。
+
+#### document_statusフォルダ
+
+- [**delivery_status.md**](type/delivery_status.md)
+
+  - 配送ステータスに関する情報を提供します。
+
+- [**authorization_status.md**](type/authorization_status.md)
+
+  - 認証ステータスに関する情報を提供します。
+
+- [**document_status.md**](type/document_status.md)
+
+  - ドキュメントのステータス管理について記載されています。
+
+- [**article_type.md**](type/article_type.md)
+
+  - 商品タイプに関する情報を提供します。
+
+- [**inbound_delivery_status.md**](type/inbound_delivery_status.md)
+
+  - 入荷配送ステータスについて記載されています。
+
+- [**incoming_payment_status.md**](type/incoming_payment_status.md)
+
+  - 受領済み支払いのステータスに関する情報を提供します。
+
+- [**tax_rounding_method.md**](type/tax_rounding_method.md)
+
+  - 税金の丸め方法について記載されています。
+
+- [**delivery_method.md**](type/delivery_method.md)
+
+  - 配送方法に関する情報を提供します。
+
+- [**document_line_status.md**](type/document_line_status.md)
+
+  - ドキュメント行のステータスについて記載されています。
+
+- [**tax_processing_method.md**](type/tax_processing_method.md)
+
+  - 税金処理の方法について記載されています。
+
+- [**temperature_control.md**](type/temperature_control.md)
+
+  - 温度管理に関する情報を提供します。
+
+- [**payment_method.md**](type/payment_method.md)
+
+  - 支払い方法に関する情報を提供します。
+
+- [**inbound_delivery_category.md**](type/inbound_delivery_category.md)
+
+  - 入荷配送カテゴリに関する情報を提供します。
+
+- [**tax_indicator.md**](type/tax_indicator.md)
+
+  - 税金インジケーターについて記載されています。
+
+- [**express_type.md**](type/express_type.md)
+
+  - エクスプレス配送のタイプについて記載されています。
+
+- [**transaction_type.md**](type/transaction_type.md)
+
+  - 取引タイプに関する情報を提供します。
+
+- [**inventory_summary_layer.md**](type/inventory_summary_layer.md)
+
+  - 在庫サマリレイヤーについて記載されています。
+
+## リンクについて
+
+ファイル間リンクや外部リンクは以下の通り修正されています：
+
+- `/developer/documents/*` へのリンクは該当するMarkdownファイルへの相対リンクに変更。
+- その他のリンクはLogilessの公式URLに変更。
+
+## 使用方法
+
+1. このリポジトリをクローンします。
+
+   ```bash
+   git clone https://github.com/solahsoyalp/LOGILESS_API_Docs_Unofficial.git
+   ```
+
+2. 各Markdownファイルを開き、必要な情報を確認してください。
+
+## 貢献
+
+- APIドキュメントに関する修正や改善案がある場合、Pull Requestを歓迎します。
+- バグ報告や機能リクエストは[GitHub Issues](https://github.com/logiless/pylogiless/issues)にてお願いします。
+
+## 著作権および免責
+
+このファイルは公式APIドキュメント（<https://app2.logiless.com/developer/>）をMarkdown形式にまとめたものです。著作権は全て株式会社ロジレスに帰属します。