# Outerport Python SDK
## Installation
```
pip install outerport
```
or
```
uv add outerport
```
## Usage
```
from outerport import OuterportClient
client = OuterportClient(
api_key="your_api_key",
base_url="https://api.outerport.com"
)
```
## Development
### Setting Up Development Environment
```bash
# Clone the repository
git clone https://github.com/outerport/outerport.git
cd outerport/outerport-python
# Install development dependencies
pip install -e ".[dev]"
```
### Running Tests
The SDK includes a comprehensive test suite:
```bash
# Run all tests
pytest
# Run only unit tests
pytest tests/unit
# Run with coverage report
pytest --cov=outerport
```
For integration tests, you'll need to set up your API key:
```bash
export OUTERPORT_API_KEY="your_api_key"
pytest tests/integration
```
See the [tests/README.md](tests/README.md) file for more details on testing.
Raw data
{
"_id": null,
"home_page": null,
"name": "outerport",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "api, outerport, sdk",
"author": null,
"author_email": "\"Outerport (Genban, Inc.)\" <support@outerport.com>",
"download_url": "https://files.pythonhosted.org/packages/66/be/6998b994c5c3715eea8022469d465b37fc818b67db9c8782cb621d308cbd/outerport-0.2.19.tar.gz",
"platform": null,
"description": "# Outerport Python SDK\n\n## Installation\n\n```\npip install outerport\n```\n\nor \n\n```\nuv add outerport\n```\n\n## Usage\n\n```\nfrom outerport import OuterportClient\n\nclient = OuterportClient(\n api_key=\"your_api_key\",\n base_url=\"https://api.outerport.com\"\n)\n```\n\n## Development\n\n### Setting Up Development Environment\n\n```bash\n# Clone the repository\ngit clone https://github.com/outerport/outerport.git\ncd outerport/outerport-python\n\n# Install development dependencies\npip install -e \".[dev]\"\n```\n\n### Running Tests\n\nThe SDK includes a comprehensive test suite:\n\n```bash\n# Run all tests\npytest\n\n# Run only unit tests\npytest tests/unit\n\n# Run with coverage report\npytest --cov=outerport\n```\n\nFor integration tests, you'll need to set up your API key:\n\n```bash\nexport OUTERPORT_API_KEY=\"your_api_key\"\npytest tests/integration\n```\n\nSee the [tests/README.md](tests/README.md) file for more details on testing.\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Outerport Python SDK",
"version": "0.2.19",
"project_urls": {
"Documentation": "https://docs.outerport.com",
"Homepage": "https://outerport.com"
},
"split_keywords": [
"api",
" outerport",
" sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9908e84eed05472573f613e02d97a5cf0ab94aa67608f00039341d75ac3db555",
"md5": "d576b60a7f1d8fb9532f3770cf2dd3f6",
"sha256": "5e6d69f13f7a084ac83e6abc487358b1d3c2abbb0aa4006ec51ae6b2757134b7"
},
"downloads": -1,
"filename": "outerport-0.2.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d576b60a7f1d8fb9532f3770cf2dd3f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24729,
"upload_time": "2025-09-02T05:27:45",
"upload_time_iso_8601": "2025-09-02T05:27:45.122887Z",
"url": "https://files.pythonhosted.org/packages/99/08/e84eed05472573f613e02d97a5cf0ab94aa67608f00039341d75ac3db555/outerport-0.2.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "66be6998b994c5c3715eea8022469d465b37fc818b67db9c8782cb621d308cbd",
"md5": "165f05342f3a42f021bab387ac270b47",
"sha256": "e3f70d7cd5bf3a846d548109363040e65128008cd466932b4013eebd8be0ef5f"
},
"downloads": -1,
"filename": "outerport-0.2.19.tar.gz",
"has_sig": false,
"md5_digest": "165f05342f3a42f021bab387ac270b47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 182477,
"upload_time": "2025-09-02T05:27:46",
"upload_time_iso_8601": "2025-09-02T05:27:46.176080Z",
"url": "https://files.pythonhosted.org/packages/66/be/6998b994c5c3715eea8022469d465b37fc818b67db9c8782cb621d308cbd/outerport-0.2.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-02 05:27:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "outerport"
}