openapi-httpx-client 0.4.3__tar.gz → 0.5.0__tar.gz

{openapi_httpx_client-0.4.3/openapi_httpx_client.egg-info → openapi_httpx_client-0.5.0}/PKG-INFO

@@ -1,28 +1,21 @@
 Metadata-Version: 2.4
 Name: openapi-httpx-client
-Version: 0.4.3
+Version: 0.5.0
 Summary: A Python client for OpenAPI specifications using httpx
-Home-page: https://github.com/lloydzhou/openapiclient
-Author: lloydzhou
-Author-email: lloydzhou@qq.com
+Author-email: lloydzhou <lloydzhou@qq.com>
+License: MIT
+Project-URL: Homepage, https://github.com/lloydzhou/openapiclient
+Project-URL: Repository, https://github.com/lloydzhou/openapiclient
 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: httpx>=0.23.0
 Requires-Dist: pyyaml>=6.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Provides-Extra: cli
+Requires-Dist: click>=8.1; extra == "cli"
 Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # OpenAPI Client for Python
 
@@ -31,9 +24,39 @@ A Python implementation inspired by [openapi-client-axios](https://github.com/op
 ## Installation
 
 ```bash
-pip install openapi-httpx-client
+pip install openapi-httpx-client        # library only
+pip install "openapi-httpx-client[cli]" # library + `oapi` command
 ```
 
+## CLI (`oapi`)
+
+The optional `[cli]` extra installs an `oapi` command that turns any OpenAPI
+spec into a CLI. Register an API once, then call its operations with generated
+commands (parameter design follows the conventions of `gh` / `restish`):
+
+```bash
+oapi connect petstore https://petstore3.swagger.io/api/v3/openapi.json
+oapi ls                                   # registered APIs
+oapi schema petstore                      # list generated commands
+oapi petstore get-pet-by-id 42            # required path params are positional
+oapi petstore find-pets-by-status --status available
+oapi petstore add-pet --body '{"name": "Rex", "photoUrls": []}'
+oapi petstore add-pet -F name=Rex -F 'photoUrls=["https://x/r.png"]'
+oapi api petstore GET /api/v3/store/inventory
+```
+
+Conventions:
+
+- operation command names are kebab-case (`getPetById` -> `get-pet-by-id`);
+  the raw `operationId` also works
+- query/header parameters become `--kebab-case` flags; `enum` values are
+  validated (`--status [available|pending|sold]`)
+- request body: `--body` (inline JSON / `@file` / `-` stdin) or repeated
+  `-F/--field key=value` (values parsed as JSON when possible)
+- stdout carries data only; diagnostics go to stderr; non-2xx exits 1
+- `--jq` filters output (`[].name`), `-o text` prints raw strings,
+  `--dry-run` prints the request without sending it
+
 ## Usage
 
 The client supports both synchronous and asynchronous usage patterns through a familiar context manager interface.

openapi_httpx_client-0.4.3/PKG-INFO → openapi_httpx_client-0.5.0/README.md

@@ -1,29 +1,3 @@
-Metadata-Version: 2.4
-Name: openapi-httpx-client
-Version: 0.4.3
-Summary: A Python client for OpenAPI specifications using httpx
-Home-page: https://github.com/lloydzhou/openapiclient
-Author: lloydzhou
-Author-email: lloydzhou@qq.com
-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: httpx>=0.23.0
-Requires-Dist: pyyaml>=6.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
 # OpenAPI Client for Python
 
 A Python implementation inspired by [openapi-client-axios](https://github.com/openapistack/openapi-client-axios) that provides a dynamic client for OpenAPI specifications. This implementation uses httpx for HTTP requests and Python's metaprogramming capabilities to dynamically generate a client with an API design similar to httpx.
@@ -31,9 +5,39 @@ A Python implementation inspired by [openapi-client-axios](https://github.com/op
 ## Installation
 
 ```bash
-pip install openapi-httpx-client
+pip install openapi-httpx-client        # library only
+pip install "openapi-httpx-client[cli]" # library + `oapi` command
 ```
 
+## CLI (`oapi`)
+
+The optional `[cli]` extra installs an `oapi` command that turns any OpenAPI
+spec into a CLI. Register an API once, then call its operations with generated
+commands (parameter design follows the conventions of `gh` / `restish`):
+
+```bash
+oapi connect petstore https://petstore3.swagger.io/api/v3/openapi.json
+oapi ls                                   # registered APIs
+oapi schema petstore                      # list generated commands
+oapi petstore get-pet-by-id 42            # required path params are positional
+oapi petstore find-pets-by-status --status available
+oapi petstore add-pet --body '{"name": "Rex", "photoUrls": []}'
+oapi petstore add-pet -F name=Rex -F 'photoUrls=["https://x/r.png"]'
+oapi api petstore GET /api/v3/store/inventory
+```
+
+Conventions:
+
+- operation command names are kebab-case (`getPetById` -> `get-pet-by-id`);
+  the raw `operationId` also works
+- query/header parameters become `--kebab-case` flags; `enum` values are
+  validated (`--status [available|pending|sold]`)
+- request body: `--body` (inline JSON / `@file` / `-` stdin) or repeated
+  `-F/--field key=value` (values parsed as JSON when possible)
+- stdout carries data only; diagnostics go to stderr; non-2xx exits 1
+- `--jq` filters output (`[].name`), `-o text` prints raw strings,
+  `--dry-run` prints the request without sending it
+
 ## Usage
 
 The client supports both synchronous and asynchronous usage patterns through a familiar context manager interface.

openapi_httpx_client-0.4.3/README.md → openapi_httpx_client-0.5.0/openapi_httpx_client.egg-info/PKG-INFO

@@ -1,3 +1,22 @@
+Metadata-Version: 2.4
+Name: openapi-httpx-client
+Version: 0.5.0
+Summary: A Python client for OpenAPI specifications using httpx
+Author-email: lloydzhou <lloydzhou@qq.com>
+License: MIT
+Project-URL: Homepage, https://github.com/lloydzhou/openapiclient
+Project-URL: Repository, https://github.com/lloydzhou/openapiclient
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: cli
+Requires-Dist: click>=8.1; extra == "cli"
+Dynamic: license-file
+
 # OpenAPI Client for Python
 
 A Python implementation inspired by [openapi-client-axios](https://github.com/openapistack/openapi-client-axios) that provides a dynamic client for OpenAPI specifications. This implementation uses httpx for HTTP requests and Python's metaprogramming capabilities to dynamically generate a client with an API design similar to httpx.
@@ -5,9 +24,39 @@ A Python implementation inspired by [openapi-client-axios](https://github.com/op
 ## Installation
 
 ```bash
-pip install openapi-httpx-client
+pip install openapi-httpx-client        # library only
+pip install "openapi-httpx-client[cli]" # library + `oapi` command
 ```
 
+## CLI (`oapi`)
+
+The optional `[cli]` extra installs an `oapi` command that turns any OpenAPI
+spec into a CLI. Register an API once, then call its operations with generated
+commands (parameter design follows the conventions of `gh` / `restish`):
+
+```bash
+oapi connect petstore https://petstore3.swagger.io/api/v3/openapi.json
+oapi ls                                   # registered APIs
+oapi schema petstore                      # list generated commands
+oapi petstore get-pet-by-id 42            # required path params are positional
+oapi petstore find-pets-by-status --status available
+oapi petstore add-pet --body '{"name": "Rex", "photoUrls": []}'
+oapi petstore add-pet -F name=Rex -F 'photoUrls=["https://x/r.png"]'
+oapi api petstore GET /api/v3/store/inventory
+```
+
+Conventions:
+
+- operation command names are kebab-case (`getPetById` -> `get-pet-by-id`);
+  the raw `operationId` also works
+- query/header parameters become `--kebab-case` flags; `enum` values are
+  validated (`--status [available|pending|sold]`)
+- request body: `--body` (inline JSON / `@file` / `-` stdin) or repeated
+  `-F/--field key=value` (values parsed as JSON when possible)
+- stdout carries data only; diagnostics go to stderr; non-2xx exits 1
+- `--jq` filters output (`[].name`), `-o text` prints raw strings,
+  `--dry-run` prints the request without sending it
+
 ## Usage
 
 The client supports both synchronous and asynchronous usage patterns through a familiar context manager interface.

{openapi_httpx_client-0.4.3 → openapi_httpx_client-0.5.0}/openapi_httpx_client.egg-info/SOURCES.txt

@@ -1,10 +1,14 @@
 LICENSE
 README.md
-setup.py
+pyproject.toml
 openapi_httpx_client.egg-info/PKG-INFO
 openapi_httpx_client.egg-info/SOURCES.txt
 openapi_httpx_client.egg-info/dependency_links.txt
+openapi_httpx_client.egg-info/entry_points.txt
 openapi_httpx_client.egg-info/requires.txt
 openapi_httpx_client.egg-info/top_level.txt
 openapiclient/__init__.py
-openapiclient/client.py
+openapiclient/cli.py
+openapiclient/client.py
+tests/test_cli.py
+tests/test_client.py

openapi_httpx_client-0.5.0/openapi_httpx_client.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+oapi = openapiclient.cli:main

{openapi_httpx_client-0.4.3 → openapi_httpx_client-0.5.0}/openapi_httpx_client.egg-info/requires.txt

@@ -1,2 +1,5 @@
 httpx>=0.23.0
 pyyaml>=6.0
+
+[cli]
+click>=8.1