Add Zapfile examples

Author: lukin0110

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     permissions: write-all
     strategy:
       matrix:
-        python-version: [ "3.13.0" ]
+        python-version: [ "3.10.16" ]
     name: Python ${{ matrix.python-version }}
     env:
       TAG: devcontainer-${{ matrix.python-version }}-${{ github.head_ref || github.ref_name }}

README.md

@@ -4,6 +4,23 @@
 
 An API Client for the terminal. A Python CLI for API testing and development.
 
+```bash
+usage: zap [-h] {run,curl,cookies,vars,version} ...
+
+An API Client for the terminal. A Python CLI for API testing and development.
+
+options:
+  -h, --help            show this help message and exit
+
+commands:
+  {run,curl,cookies,vars,version}
+    run                 🚀 run a Zapfile
+    curl                🌊 print the curl command for a Zapfile
+    cookies             🍪 view stored cookies
+    vars                📋 view stored variables
+    version             🔖 show version
+```
+
 ## ✨ Features
 
 - 🛠️ Environments & variables

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]  # https://python-poetry.org/docs/pyproject/
 name = "zapman"
-version = "0.0.1"
+version = "0.0.2"
 description = "An API Client for the terminal. A Python CLI for API testing and development."
 authors = []
 license = "Proprietary"

src/zapman/__main__.py

@@ -19,8 +19,9 @@ def main() -> None:  # noqa: PLR0911,C901
 
     parser = argparse.ArgumentParser(
         prog="zap",
-        description="A Python tool for API testing and development in your terminal.",
+        description="An API Client for the terminal. A Python CLI for API testing and development.",
     )
+
     subparser = parser.add_subparsers(
         title="commands",
         dest="command",
@@ -34,9 +35,8 @@ def main() -> None:  # noqa: PLR0911,C901
     run.add_argument("-d", "--download", action="store_true", help="💾 download the response body")
     run.add_argument("-q", "--quiet", action="store_true", help="🤫 suppress output")
     run.add_argument("-v", "--verbose", action="store_true", help="🐞 enable debug logging", default=False)
-    run.add_argument("--curl", action="store_true", help="🌊 print the curl command")
     run.add_argument("path", type=str, help="🐍 the Zapfile to execute", nargs="?", default=None)
-    curl = subparser.add_parser("curl", help="🌊 print curl command")
+    curl = subparser.add_parser("curl", help="🌊 print the curl command for a Zapfile")
     curl.add_argument("-e", "--env", type=str, help="🌐 API environment to use (default=default)", default="default")
     curl.add_argument("path", type=str, help="🐍 the Zapfile to print the curl command")
     subparser.add_parser("cookies", help="🍪 view stored cookies")

zaps/cookies.py

@@ -0,0 +1,6 @@
+###################################
+# $ zap run cookies.py
+# $ zap cookies
+###################################
+
+GET = "https://pie.dev/cookies/set/foo/bar"

zaps/delete.py

@@ -1,3 +1,6 @@
+###################################
+# $ zap run delete.py
+###################################
 from zapman import env
 
 DELETE = f"{env['endpoint']}/delete"

zaps/download.py

@@ -0,0 +1,14 @@
+###################################
+# $ zap run download.py
+###################################
+from zapman import After
+
+GET = "https://httpbin.org/get"
+
+DOWNLOAD = True
+
+
+def after(ctx: After) -> None:
+    ctx.info("Downloaded 🤘")
+    if ctx.output_file:
+        print(ctx.output_file.read_text())

zaps/empty.py

@@ -0,0 +1,3 @@
+###################################
+# $ zap run empty.py
+###################################

zaps/error.py

@@ -0,0 +1,5 @@
+###################################
+# $ zap run error.py
+###################################
+GET = 1
+BODY_JSON = ""

zaps/form.py

@@ -1,3 +1,6 @@
+###################################
+# $ zap run form.py
+###################################
 from zapman import env
 
 POST = f"{env['endpoint']}/post"