pylapi 0.12.16__tar.gz

pylapi-0.12.16/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jacky Ko
+
+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.

pylapi-0.12.16/OVERVIEW.md

@@ -0,0 +1,113 @@
+# PyLapi
+
+Python Lightweight API (PyLapi) is a Python API builder. It takes only a few seconds to automatically generate a Python API from OpenAPI specifications or less than an hour for an experienced Python developer to create a custom Python API.
+
+You can drive PyLapi in an [automatic](https://github.com/jackyko8/pylapi/tree/main/tutorials/2.%20How%20to%20use%20a%20PyLapi%20API.ipynb), [semiautomatic](https://github.com/jackyko8/pylapi/tree/main/tutorials/5.%20PyLapi%20Generator%20Automation.ipynb), or [manual](https://github.com/jackyko8/pylapi/tree/main/tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb) way.
+
+***Automatic***:
+
+The auto-generated Python API contains fully functional resource classes with API methods embedded with OpenAPI specifications as user guide inline comments, so you don't need to read the lengthy OpenAPI Specification to study or use the API.
+
+For more details, please see this [tutorial](https://github.com/jackyko8/pylapi/tree/main/tutorials/2.%20How%20to%20use%20a%20PyLapi%20API.ipynb) on how to use the generated API.
+
+***Semiautomatic***:
+
+You can also manually "rewrite" some of the generated classes and methods in a separate code file to, for example, specify custom parameters, pre-process the request, or post-process the response. The PyLapi generator will merge your code into the generated Python API automatically.
+
+PyLapi's code-rewrite feature allows you to specify different API URL endpoints for individual resources, effectively combining multiple API backend services into a single frontend API. All parameters and the request body are dynamically mapped based on the API method route, with the option to rewrite them if you so choose.
+
+More details can be found in this [tutorial](https://github.com/jackyko8/pylapi/tree/main/tutorials/5.%20PyLapi%20Generator%20Automation.ipynb).
+
+***Manual***:
+
+When OpenAPI Specifications are not available or you want to create a Python API your own way, you can inherit your root API class from PyLapi, which does all the heavy lifting for you, so your code would mostly be a `pass`.
+
+If you want to manipulate the API requests and responses, only minimal coding is required. In the tutorial [A ChatGPT Conversation with PyLapi](https://github.com/jackyko8/pylapi/tree/main/tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb), a fully functional Conversation resource is completed in 38 lines, allowing you to do cool things like this:
+
+```python
+conversation.ask("Where is the Sydney Opera House?")
+print(conversation.data.answers[0])
+# Output:
+# The Sydney Opera House is located in Sydney, Australia. Specifically, it is situated on Bennelong Point in the Sydney Harbour, close to the Sydney Harbour Bridge.
+```
+
+When OpenAPI Specifications are not available or you want to create a Python API your own way, you can inherit your API class from PyLapi, which does all the heavy lifting for you, so your code would mostly be a `pass`. For example,
+
+More details can be found in this [tutorial](https://github.com/jackyko8/pylapi/tree/main/tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb).
+
+
+## A PyLapi code example
+
+Here is a sample of a PyLapi API:
+
+```python
+from pylapi import PyLapi
+
+class MyAPI(PyLapi):
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self.api_url = "https://api.example.com"
+        self.api_auth_type = "Bearer"
+
+# resource_name="invoice", resource_base_path="invoices"
+@MyAPI.resource_class("invoice", "invoices")
+class InvoiceResource(MyAPI):
+
+    @MyAPI.resource_method("{invoice_number}", http_method="GET")
+    def getInvoice(self): pass
+    # To call: MyAPI.resource("invoice").getInvoice(...)
+    # Request: GET https://api.example.com/invoices/{invoice_number}
+```
+
+The `MyAPI` API root class inherits the decorators `@MyAPI.resource_class` and `@MyAPI.resource_methods` from `PyLapi`, which prepares the API parameters and the request body in the API request, sends the request to the API URL endpoint, processes the response, and handles the resource data for you.
+
+---
+The PyLapi framework makes it very easy and natural for you to use a PyLapi-supported Python API. For example,
+
+```python
+from myapi import MyAPI
+
+MyAPI.auth(AUTH_ACCESS_TOKEN)
+
+invoice = MyAPI.resource("invoice")
+invoice.data = invoice.getInvoice("12345678") # using positional arguments
+print(invoice)
+
+item_list = invoice.getItemList()
+product = MyAPI.resource("product")
+invoice_total = 0.0
+for item in item_list:
+    product.data.number = item["product_number"]
+    product.data = product.getProduct() # using implicit arguments from product.data
+    subtotal = product.data.price * item["qty"]
+    invoice_total += subtotal
+    print(f"Item: {product.data.name}")
+    print(f"  Price: ${product.data.price:0.2f}")
+    print(f"  Qty: {item['qty']}")
+    print(f"  Subtotal: ${subtotal:0.2f}")
+print(f"Invoice Total: ${invoice_total:0.2f}")
+```
+
+## Install PyLapi
+
+Please follow these instructions to install PyLapi and its generator, replacing all variables accordingly.
+
+To install the PyLapi class:
+```bash
+pip install pylapi
+```
+
+To generate a PyLapi supported Python API:
+
+```bash
+pylapi-autogen --template > myapi_config.py
+# Configure myapi_config.py
+pylapi-autogen myapi_config.py
+# Output
+# MyAPI generated and saved in ./myapi.py
+```
+
+## More Information
+
+PyLapi [tutorial](https://github.com/jackyko8/pylapi/blob/main/tutorials) and [user guide](https://github.com/jackyko8/pylapi/blob/main/user_guide) are available at the [PyLapi](https://github.com/jackyko8/pylapi) GitHub repository.
+PyLapi API is documented on [Read the Docs](https://pylapi.readthedocs.io/).

pylapi-0.12.16/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.1
+Name: pylapi
+Version: 0.12.16
+Summary: Python Lightweight API (PyLapi)
+Home-page: https://github.com/jackyko8/pylapi
+Author: Jacky Ko
+Author-email: 
+License: MIT
+Project-URL: Changelog, https://github.com/jackyko8/pylapi/blob/main/RELEASE.md
+Project-URL: Code, https://github.com/jackyko8/pylapi
+Project-URL: Download, https://pypi.org/project/pylapi/
+Project-URL: Homepage, https://www.pylapi.org/
+Project-URL: Issue tracker, https://github.com/jackyko8/pylapi/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: magico>=1.0
+Requires-Dist: urllib3<1.27,>=1.21.1
+Requires-Dist: requests>=2.5
+Requires-Dist: PyYAML>=5.1
+
+# PyLapi
+
+Python Lightweight API (PyLapi) is a Python API builder. It takes only a few seconds to automatically generate a Python API from OpenAPI specifications or less than an hour for an experienced Python developer to create a custom Python API.
+
+You can drive PyLapi in an [automatic](https://github.com/jackyko8/pylapi/tree/main/tutorials/2.%20How%20to%20use%20a%20PyLapi%20API.ipynb), [semiautomatic](https://github.com/jackyko8/pylapi/tree/main/tutorials/5.%20PyLapi%20Generator%20Automation.ipynb), or [manual](https://github.com/jackyko8/pylapi/tree/main/tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb) way.
+
+***Automatic***:
+
+The auto-generated Python API contains fully functional resource classes with API methods embedded with OpenAPI specifications as user guide inline comments, so you don't need to read the lengthy OpenAPI Specification to study or use the API.
+
+For more details, please see this [tutorial](https://github.com/jackyko8/pylapi/tree/main/tutorials/2.%20How%20to%20use%20a%20PyLapi%20API.ipynb) on how to use the generated API.
+
+***Semiautomatic***:
+
+You can also manually "rewrite" some of the generated classes and methods in a separate code file to, for example, specify custom parameters, pre-process the request, or post-process the response. The PyLapi generator will merge your code into the generated Python API automatically.
+
+PyLapi's code-rewrite feature allows you to specify different API URL endpoints for individual resources, effectively combining multiple API backend services into a single frontend API. All parameters and the request body are dynamically mapped based on the API method route, with the option to rewrite them if you so choose.
+
+More details can be found in this [tutorial](https://github.com/jackyko8/pylapi/tree/main/tutorials/5.%20PyLapi%20Generator%20Automation.ipynb).
+
+***Manual***:
+
+When OpenAPI Specifications are not available or you want to create a Python API your own way, you can inherit your root API class from PyLapi, which does all the heavy lifting for you, so your code would mostly be a `pass`.
+
+If you want to manipulate the API requests and responses, only minimal coding is required. In the tutorial [A ChatGPT Conversation with PyLapi](https://github.com/jackyko8/pylapi/tree/main/tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb), a fully functional Conversation resource is completed in 38 lines, allowing you to do cool things like this:
+
+```python
+conversation.ask("Where is the Sydney Opera House?")
+print(conversation.data.answers[0])
+# Output:
+# The Sydney Opera House is located in Sydney, Australia. Specifically, it is situated on Bennelong Point in the Sydney Harbour, close to the Sydney Harbour Bridge.
+```
+
+When OpenAPI Specifications are not available or you want to create a Python API your own way, you can inherit your API class from PyLapi, which does all the heavy lifting for you, so your code would mostly be a `pass`. For example,
+
+More details can be found in this [tutorial](https://github.com/jackyko8/pylapi/tree/main/tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb).
+
+
+## A PyLapi code example
+
+Here is a sample of a PyLapi API:
+
+```python
+from pylapi import PyLapi
+
+class MyAPI(PyLapi):
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self.api_url = "https://api.example.com"
+        self.api_auth_type = "Bearer"
+
+# resource_name="invoice", resource_base_path="invoices"
+@MyAPI.resource_class("invoice", "invoices")
+class InvoiceResource(MyAPI):
+
+    @MyAPI.resource_method("{invoice_number}", http_method="GET")
+    def getInvoice(self): pass
+    # To call: MyAPI.resource("invoice").getInvoice(...)
+    # Request: GET https://api.example.com/invoices/{invoice_number}
+```
+
+The `MyAPI` API root class inherits the decorators `@MyAPI.resource_class` and `@MyAPI.resource_methods` from `PyLapi`, which prepares the API parameters and the request body in the API request, sends the request to the API URL endpoint, processes the response, and handles the resource data for you.
+
+---
+The PyLapi framework makes it very easy and natural for you to use a PyLapi-supported Python API. For example,
+
+```python
+from myapi import MyAPI
+
+MyAPI.auth(AUTH_ACCESS_TOKEN)
+
+invoice = MyAPI.resource("invoice")
+invoice.data = invoice.getInvoice("12345678") # using positional arguments
+print(invoice)
+
+item_list = invoice.getItemList()
+product = MyAPI.resource("product")
+invoice_total = 0.0
+for item in item_list:
+    product.data.number = item["product_number"]
+    product.data = product.getProduct() # using implicit arguments from product.data
+    subtotal = product.data.price * item["qty"]
+    invoice_total += subtotal
+    print(f"Item: {product.data.name}")
+    print(f"  Price: ${product.data.price:0.2f}")
+    print(f"  Qty: {item['qty']}")
+    print(f"  Subtotal: ${subtotal:0.2f}")
+print(f"Invoice Total: ${invoice_total:0.2f}")
+```
+
+## Install PyLapi
+
+Please follow these instructions to install PyLapi and its generator, replacing all variables accordingly.
+
+To install the PyLapi class:
+```bash
+pip install pylapi
+```
+
+To generate a PyLapi supported Python API:
+
+```bash
+pylapi-autogen --template > myapi_config.py
+# Configure myapi_config.py
+pylapi-autogen myapi_config.py
+# Output
+# MyAPI generated and saved in ./myapi.py
+```
+
+## More Information
+
+PyLapi [tutorial](https://github.com/jackyko8/pylapi/blob/main/tutorials) and [user guide](https://github.com/jackyko8/pylapi/blob/main/user_guide) are available at the [PyLapi](https://github.com/jackyko8/pylapi) GitHub repository.
+PyLapi API is documented on [Read the Docs](https://pylapi.readthedocs.io/).

pylapi-0.12.16/README.md

@@ -0,0 +1,30 @@
+# PyLapi
+
+Python Lightweight API (PyLapi) is a Python API builder. It takes only a few seconds to automatically generate a Python API from OpenAPI specifications or less than an hour for an experienced Python developer to create a custom Python API.
+
+You can drive PyLapi in an [automatic](./tutorials/2.%20How%20to%20use%20a%20PyLapi%20API.ipynb), [semiautomatic](./tutorials/5.%20PyLapi%20Generator%20Automation.ipynb), or [manual](./tutorials/3.%20A%20ChatGPT%20Conversation%20with%20PyLapi.ipynb) way.
+Here is an [overview](./OVERVIEW.md).
+
+## Install PyLapi
+
+Please follow these instructions to install PyLapi and its generator, replacing all variables accordingly.
+
+To install the PyLapi class:
+```bash
+pip install pylapi
+```
+
+To generate a PyLapi supported Python API:
+
+```bash
+pylapi-autogen --template > myapi_config.py
+# Configure myapi_config.py
+pylapi-autogen myapi_config.py
+# Output
+# MyAPI generated and saved in ./myapi.py
+```
+
+## More Information
+
+PyLapi [tutorial](https://github.com/jackyko8/pylapi/blob/main/tutorials) and [user guide](https://github.com/jackyko8/pylapi/blob/main/user_guide) are available at the [PyLapi](https://github.com/jackyko8/pylapi) GitHub repository.
+PyLapi API is documented on [Read the Docs](https://pylapi.readthedocs.io/).

pylapi-0.12.16/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pylapi"
+description = "Python Lightweight API (PyLapi)"
+readme = "OVERVIEW.md"
+urls.Changelog = "https://github.com/jackyko8/pylapi/blob/main/RELEASE.md"
+urls.Code = "https://github.com/jackyko8/pylapi"
+urls.Download = "https://pypi.org/project/pylapi/"
+urls.Homepage = "https://www.pylapi.org/"
+urls."Issue tracker" = "https://github.com/jackyko8/pylapi/issues"
+requires-python = ">=3.7"
+dynamic = ["version"]
+
+dependencies = [
+    "magico>=1.0",
+    "urllib3>=1.21.1,<1.27",
+    "requests>=2.5",
+    "PyYAML>=5.1",
+]
+
+[project.scripts]
+pylapi-autogen = "pylapi.autogen:main"

pylapi-0.12.16/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pylapi-0.12.16/setup.py

@@ -0,0 +1,45 @@
+import setuptools
+import os
+
+about = {}
+with open(f"{os.path.abspath(os.path.dirname(__file__))}/src/pylapi/__version__.py", "r") as f:
+    exec(f.read(), about)
+
+with open("OVERVIEW.md", "r", encoding="utf-8") as f:
+    long_description = f.read()
+
+setuptools.setup(
+    name=about["__name__"],
+    version=about["__version__"],
+    description=about["__description__"],
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url=about["__url__"],
+    author=about["__author__"],
+    author_email=about["__author_email__"],
+    license=about["__license__"],
+
+    packages=[about["__name__"]],
+    package_data={"": ["LICENSE"]},
+    package_dir={"": "src"},
+    python_requires=">=3.7",
+
+    install_requires=[
+        "magico>=0.3.3",
+        "urllib3>=1.21.1,<1.27",
+        "requests>=2.5",
+        "PyYAML>=5.1",
+    ],
+
+    project_urls={
+        "Source": about["__url__"],
+        "Documentation": about["__url__"] + "/blob/main/tutorials",
+        "Bug Tracker": about["__url__"] + "/issues",
+    },
+
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)

pylapi-0.12.16/src/pylapi/__init__.py

@@ -0,0 +1 @@
+from .pylapi import *

pylapi-0.12.16/src/pylapi/__version__.py

@@ -0,0 +1,8 @@
+__name__ = "pylapi"
+__version__ = "0.12.16"
+__description__ = "PyLapi - Python Lightweight API"
+__url__ = "https://github.com/jackyko8/pylapi"
+__author__ = "Jacky Ko"
+__author_email__ = ""
+__license__ = "MIT"
+__copyright__ = "Copyright Jacky Ko"