# Jaxl CLI & Jaxl Python API Client
Use Jaxl from Python code or directly via the `jaxl` command-line tool.
1. [Install](#install)
2. [JAXL CLI](#jaxl-cli)
- [CLI Example Usage](#cli-example-usage)
3. [Jaxl Python SDK](#jaxl-python-sdk)
- [SDK Example Usage](#sdk-example-usage)
4. [Documentation](#documentation)
5. [Status](#status)
## Install
`pip install jaxl-python`
## JAXL CLI
```bash
jaxl -h
usage: jaxl [-h] {calls} ...
Jaxl CLI
positional arguments:
{phones,calls,members,teams,ivrs,devices,payments,accounts,kycs,messages,campaigns,notifications}
phones Manage Phones
calls Manage Calls (Domestic & International Cellular, VoIP audio/video)
members Manage Members
teams Manage Teams
ivrs Manage IVRs (Interactive Voice Response)
devices Manage Devices
payments Manage Payments
accounts Manage Accounts
kycs Manage KYCs
messages Manage Messages (SMS, WA, RCS, Email, App-to-App)
campaigns Manage Campaigns
notifications Manage Notifications (iOS, Android, Web)
options:
-h, --help show this help message and exit
```
### CLI Example Usage
```bash
export JAXL_API_CREDENTIALS=/path/to/jaxl-api-credentials.json
export JAXL_API_AUTH_TOKEN="....authentication token..."
jaxl calls list
Response(status_code=<HTTPStatus.OK: 200>, content=b'... [redacted] ...')
```
## Jaxl Python SDK
- Jaxl APIs is built upon [OpenAPI specification](https://www.openapis.org/)
- `jaxl-python` contains following Python modules:
- `jaxl.api.client`: Generated OpenAPI SDK
- `jaxl.api.resources`: Wrapper methods written to support `jaxl` CLI
- `jaxl_api_client`: Helper function to retrieve an instance of `JaxlApiClient`
### SDK Example Usage:
```python
from jaxl.api import JaxlApiModule, jaxl_api_client
from jaxl.api.client.api.v1 import v1_calls_list
os.environ.setdefault("JAXL_API_CREDENTIALS", "/path/to/jaxl-api-credentials.json")
os.environ.setdefault("JAXL_API_AUTH_TOKEN", "....authentication token...")
response = v1_calls_list.sync_detailed(
client=jaxl_api_client(JaxlApiModule.CALL),
currency=2, # 1=USD, 2=INR
)
```
## Documentation
```
# Clone this repository
git clone git@github.com:jaxl-innovations-private-limited/jaxl-python.git
# Enter cloned repo directory
cd jaxl-python
# Create virtual environment
python3 -m venv .venv
# Activate virtual environment
source .venv/bin/activate
# Install
pip install -e ".[dev]"
# Generate documentation
./docs.sh
# View documentation in browser
open docs/jaxl/index.html
```
## Status
[](https://www.python.org/)
[](http://mypy-lang.org/)
Raw data
{
"_id": null,
"home_page": "https://github.com/jaxl-innovations-private-limited/jaxl-python",
"name": "jaxl-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "jaxl, api, client, sdk, openapi",
"author": "Jaxl Innovations Private Limited",
"author_email": "engineering@jaxl.com",
"download_url": "https://files.pythonhosted.org/packages/72/eb/e8dd5cf186f75513b27fd95960acf8d971bedafe71e79f3d2ddaf458fac3/jaxl_python-0.0.1.tar.gz",
"platform": null,
"description": "# Jaxl CLI & Jaxl Python API Client\n\nUse Jaxl from Python code or directly via the `jaxl` command-line tool.\n\n1. [Install](#install)\n2. [JAXL CLI](#jaxl-cli)\n - [CLI Example Usage](#cli-example-usage)\n3. [Jaxl Python SDK](#jaxl-python-sdk)\n - [SDK Example Usage](#sdk-example-usage)\n4. [Documentation](#documentation)\n5. [Status](#status)\n\n## Install\n\n`pip install jaxl-python`\n\n## JAXL CLI\n\n```bash\njaxl -h\nusage: jaxl [-h] {calls} ...\n\nJaxl CLI\n\npositional arguments:\n {phones,calls,members,teams,ivrs,devices,payments,accounts,kycs,messages,campaigns,notifications}\n phones Manage Phones\n calls Manage Calls (Domestic & International Cellular, VoIP audio/video)\n members Manage Members\n teams Manage Teams\n ivrs Manage IVRs (Interactive Voice Response)\n devices Manage Devices\n payments Manage Payments\n accounts Manage Accounts\n kycs Manage KYCs\n messages Manage Messages (SMS, WA, RCS, Email, App-to-App)\n campaigns Manage Campaigns\n notifications Manage Notifications (iOS, Android, Web)\n\noptions:\n -h, --help show this help message and exit\n```\n\n### CLI Example Usage\n\n```bash\nexport JAXL_API_CREDENTIALS=/path/to/jaxl-api-credentials.json\n\nexport JAXL_API_AUTH_TOKEN=\"....authentication token...\"\n\njaxl calls list\n\nResponse(status_code=<HTTPStatus.OK: 200>, content=b'... [redacted] ...')\n```\n\n## Jaxl Python SDK\n\n- Jaxl APIs is built upon [OpenAPI specification](https://www.openapis.org/)\n- `jaxl-python` contains following Python modules:\n - `jaxl.api.client`: Generated OpenAPI SDK\n - `jaxl.api.resources`: Wrapper methods written to support `jaxl` CLI\n - `jaxl_api_client`: Helper function to retrieve an instance of `JaxlApiClient`\n\n### SDK Example Usage:\n\n```python\nfrom jaxl.api import JaxlApiModule, jaxl_api_client\nfrom jaxl.api.client.api.v1 import v1_calls_list\n\nos.environ.setdefault(\"JAXL_API_CREDENTIALS\", \"/path/to/jaxl-api-credentials.json\")\n\nos.environ.setdefault(\"JAXL_API_AUTH_TOKEN\", \"....authentication token...\")\n\nresponse = v1_calls_list.sync_detailed(\n client=jaxl_api_client(JaxlApiModule.CALL),\n currency=2, # 1=USD, 2=INR\n)\n```\n\n## Documentation\n\n```\n# Clone this repository\ngit clone git@github.com:jaxl-innovations-private-limited/jaxl-python.git\n\n# Enter cloned repo directory\ncd jaxl-python\n\n# Create virtual environment\npython3 -m venv .venv\n\n# Activate virtual environment\nsource .venv/bin/activate\n\n# Install\npip install -e \".[dev]\"\n\n# Generate documentation\n./docs.sh\n\n# View documentation in browser\nopen docs/jaxl/index.html\n```\n\n## Status\n\n[](https://www.python.org/)\n\n[](http://mypy-lang.org/)\n",
"bugtrack_url": null,
"license": "'Proprietary'",
"summary": "Jaxl CLI & Jaxl Python API Client.",
"version": "0.0.1",
"project_urls": {
"CI: GitHub": "https://github.com/jaxl-innovations-private-limited/jaxl-python/actions",
"Download": "https://github.com/jaxl-innovations-private-limited/jaxl-python/archive/main.zip",
"GitHub: discussions": "https://github.com/jaxl-innovations-private-limited/jaxl-python/discussions",
"GitHub: issues": "https://github.com/jaxl-innovations-private-limited/jaxl-python/issues",
"GitHub: repo": "https://github.com/jaxl-innovations-private-limited/jaxl-python",
"Homepage": "https://github.com/jaxl-innovations-private-limited/jaxl-python"
},
"split_keywords": [
"jaxl",
" api",
" client",
" sdk",
" openapi"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7fa4c6f62a55a177fb6a38dde2553d4eb87adf3b5d8a9888240bb0bdf4c4a63e",
"md5": "1adb86da5dcb11365ee25dce51075ce9",
"sha256": "f6aa8ce9fcfcbdeeaa4035964a98baa183e52dae794a2768e5dc98f0febe2cb3"
},
"downloads": -1,
"filename": "jaxl_python-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1adb86da5dcb11365ee25dce51075ce9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 806134,
"upload_time": "2025-07-21T19:38:41",
"upload_time_iso_8601": "2025-07-21T19:38:41.660074Z",
"url": "https://files.pythonhosted.org/packages/7f/a4/c6f62a55a177fb6a38dde2553d4eb87adf3b5d8a9888240bb0bdf4c4a63e/jaxl_python-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "72ebe8dd5cf186f75513b27fd95960acf8d971bedafe71e79f3d2ddaf458fac3",
"md5": "d22fcb9ba6fce6b4ac766f19bc5299ae",
"sha256": "8178cdbf89a37d53e9c1ef7c9557b0b02d31d80092246e053bef70c0acc502ff"
},
"downloads": -1,
"filename": "jaxl_python-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "d22fcb9ba6fce6b4ac766f19bc5299ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 209800,
"upload_time": "2025-07-21T19:38:43",
"upload_time_iso_8601": "2025-07-21T19:38:43.273374Z",
"url": "https://files.pythonhosted.org/packages/72/eb/e8dd5cf186f75513b27fd95960acf8d971bedafe71e79f3d2ddaf458fac3/jaxl_python-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-21 19:38:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jaxl-innovations-private-limited",
"github_project": "jaxl-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jaxl-python"
}
JSON
