feat: add polywrap package and examples

.github/workflows/ci.yaml

@@ -45,18 +45,9 @@ jobs:
         run: curl -sSL https://install.python-poetry.org | python3 -
       - name: Install dependencies
         run: poetry install
-      - name: Plugin Codegen
+      - name: Plugins Codegen
         run: yarn codegen
-        if: contains(matrix.package, 'plugins')
-      - name: Config Bundle Codegen
-        run: yarn codegen
-        if: contains(matrix.package, 'config-bundles')
-      - name: Client Codegen
-        run: yarn codegen
-        if: endsWith(matrix.package, 'polywrap-client')
-      - name: Client Config Builder Codegen
-        run: yarn codegen
-        if: endsWith(matrix.package, 'polywrap-client-config-builder')
+        working-directory: packages/polywrap
       - name: Typecheck
         run: poetry run tox -e typecheck
       - name: Lint

.github/workflows/examples-ci.yaml

@@ -0,0 +1,35 @@
+name: Examples-CI
+on:
+  push: 
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  examples:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./examples
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Setup Node.js
+        uses: actions/setup-node@master
+        with:
+          node-version: 'v18.16.0'
+      - name: Install poetry
+        run: curl -sSL https://install.python-poetry.org | python3 -
+      - name: Install dependencies
+        run: poetry install
+      - name: Start polywrap infra
+        run: npx polywrap infra up --modules=eth-ens-ipfs
+      - name: Codegen
+        run: yarn codegen
+        working-directory: ./packages/polywrap-client
+      - name: Run tests
+        run: poetry run pytest -v

docs/pyproject.toml

@@ -23,6 +23,7 @@ polywrap-http-plugin = { path = "../packages/plugins/polywrap-http-plugin", deve
 polywrap-ethereum-provider = { path = "../packages/plugins/polywrap-ethereum-provider", develop = true }
 polywrap-sys-config-bundle = { path = "../packages/config-bundles/polywrap-sys-config-bundle", develop = true }
 polywrap-web3-config-bundle = { path = "../packages/config-bundles/polywrap-web3-config-bundle", develop = true }
+polywrap = { path = "../packages/polywrap", develop = true }
 
 [tool.poetry.group.dev.dependencies]
 sphinx = "^6.1.3"

docs/source/Quickstart.rst

@@ -1,18 +1,29 @@
-Polywrap Client
-===============
-This package contains the implementation of polywrap python client.
+Polywrap
+========
+This package contains the Polywrap Python SDK
+
+Installation
+============
+Install the package with pip:
+
+.. code-block:: bash
+
+    pip install polywrap
 
 Quickstart
 ==========
 
 Imports
 -------
 
->>> from polywrap_core import Uri, ClientConfig
->>> from polywrap_client import PolywrapClient
->>> from polywrap_client_config_builder import PolywrapClientConfigBuilder
->>> from polywrap_sys_config_bundle import sys_bundle
->>> from polywrap_web3_config_bundle import web3_bundle
+>>> from polywrap import (
+...     Uri,
+...     ClientConfig,
+...     PolywrapClient,
+...     PolywrapClientConfigBuilder,
+...     sys_bundle,
+...     web3_bundle
+... )
 
 Configure and Instantiate
 -------------------------

docs/source/conf.py

@@ -22,11 +22,13 @@
   "sphinx.ext.napoleon",
   "sphinx.ext.autosummary",
   "sphinx.ext.viewcode",
+  "myst_parser",
 ]
 
 templates_path = ['_templates']
 exclude_patterns = []
 
+source_suffix = [".rst", ".md"]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -54,5 +56,5 @@
 shutil.rmtree(os.path.join(root_dir, "docs", "source", "misc"), ignore_errors=True)
 shutil.copytree(os.path.join(root_dir, "misc"), os.path.join(root_dir, "docs", "source", "misc"))
 
-shutil.copy2(os.path.join(root_dir, "packages", "polywrap-client", "README.rst"), os.path.join(root_dir, "docs", "source", "Quickstart.rst"))
+shutil.copy2(os.path.join(root_dir, "packages", "polywrap", "README.rst"), os.path.join(root_dir, "docs", "source", "Quickstart.rst"))
 shutil.copy2(os.path.join(root_dir, "CONTRIBUTING.rst"), os.path.join(root_dir, "docs", "source", "CONTRIBUTING.rst"))

docs/source/examples/ens.md

@@ -0,0 +1 @@
+../../../examples/ens.md

docs/source/examples/ethers.md

@@ -0,0 +1 @@
+../../../examples/ethers.md

docs/source/examples/examples.rst

@@ -0,0 +1,11 @@
+Examples
+========
+
+.. toctree::
+    :maxdepth: 4
+
+    ens.md
+    ethers.md
+    filesystem.md
+    http.md
+    ipfs.md

docs/source/examples/filesystem.md

@@ -0,0 +1 @@
+../../../examples/filesystem.md

docs/source/examples/http.md

@@ -0,0 +1 @@
+../../../examples/http.md

docs/source/examples/ipfs.md

@@ -0,0 +1 @@
+../../../examples/ipfs.md

docs/source/index.rst

@@ -13,6 +13,7 @@ Welcome to polywrap-client's documentation!
    :maxdepth: 1
    :caption: Contents:
 
+   examples/examples.rst
    CONTRIBUTING.rst
    polywrap-client/modules.rst
    polywrap-client-config-builder/modules.rst

examples/.gitignore

@@ -0,0 +1 @@
+.polywrap

examples/README.md

@@ -0,0 +1,33 @@
+# Polywrap Python Client Examples
+
+This directory contains examples of how to use the Polywrap Python client.
+
+## Running the Examples
+
+### Install Dependencies
+
+```
+poetry install
+```
+
+> NOTE: if you don't have Poetry installed, you can follow the instructions [here](https://python-poetry.org/docs/#installation).
+
+### Run the Examples
+
+```
+poetry run pytest
+```
+
+> We are using markdown_pytest plugin to run the examples. You can find more information about it [here](https://pypi.org/project/markdown-pytest/).
+
+### Run a Specific Example
+
+```
+poetry run pytest <example_name>
+```
+
+For example:
+
+```
+poetry run pytest ens.md
+```