posit-sdk

Name	posit-sdk JSON
Version	0.11.0 JSON
	download
home_page	None
Summary	Posit SDK for Python
upload_time	2025-07-14 15:33:10
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	MIT License Copyright (c) 2024 posit-dev Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	posit sdk
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage

            # Posit SDK for Python

This package provides a Pythonic interface for developers to work against the public APIs of Posit's professional products. It is intended to be lightweight yet expressive.

> The Posit SDK is in the very early stages of development, and currently only Posit Connect has any support.

## Installation

```shell
pip install posit-sdk
```

## Usage

Establish server information and credentials using the following environment variables or when initializing a client. Then checkout the [Posit Connect Cookbook](https://docs.posit.co/connect/cookbook/) to get started.

> [!CAUTION]
> It is important to keep your API key safe and secure. Your API key grants access to your account and allows you to make authenticated requests to the Posit API. Treat your API key like a password and avoid sharing it with others. If you suspect that your API key has been compromised, regenerate a new one immediately to maintain the security of your account.

### Option 1 (Preferred)

```shell
export CONNECT_API_KEY="my-secret-api-key"
export CONNECT_SERVER="https://example.com/"
```

```python
from posit.connect import Client

client = Client()
```

### Option 2

```shell
export CONNECT_API_KEY="my-secret-api-key"
```

```python
from posit.connect import Client

Client("https://example.com")
```

### Option 3

```python
from posit.connect import Client

Client("https://example.com", "my-secret-api-key")
```

## Contributing

We welcome contributions to the Posit SDK for Python! If you would like to contribute, see the [CONTRIBUTING](CONTRIBUTING.md) guide for instructions.

## Issues

If you encounter any issues or have any questions, please [open an issue](https://github.com/posit-dev/posit-sdk-py/issues). We appreciate your feedback.

## License

This project is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute the code as you see fit.

## Code of Conduct

We expect all contributors to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md) and create a positive and inclusive community.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "posit-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "posit, sdk",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/59/ef/bf8debb863dc2d020a73e0dc993aa14dd0adffb69da4d6ef767fa2becbf2/posit_sdk-0.11.0.tar.gz",
    "platform": null,
    "description": "# Posit SDK for Python\n\nThis package provides a Pythonic interface for developers to work against the public APIs of Posit's professional products. It is intended to be lightweight yet expressive.\n\n> The Posit SDK is in the very early stages of development, and currently only Posit Connect has any support.\n\n## Installation\n\n```shell\npip install posit-sdk\n```\n\n## Usage\n\nEstablish server information and credentials using the following environment variables or when initializing a client. Then checkout the [Posit Connect Cookbook](https://docs.posit.co/connect/cookbook/) to get started.\n\n> [!CAUTION]\n> It is important to keep your API key safe and secure. Your API key grants access to your account and allows you to make authenticated requests to the Posit API. Treat your API key like a password and avoid sharing it with others. If you suspect that your API key has been compromised, regenerate a new one immediately to maintain the security of your account.\n\n### Option 1 (Preferred)\n\n```shell\nexport CONNECT_API_KEY=\"my-secret-api-key\"\nexport CONNECT_SERVER=\"https://example.com/\"\n```\n\n```python\nfrom posit.connect import Client\n\nclient = Client()\n```\n\n### Option 2\n\n```shell\nexport CONNECT_API_KEY=\"my-secret-api-key\"\n```\n\n```python\nfrom posit.connect import Client\n\nClient(\"https://example.com\")\n```\n\n### Option 3\n\n```python\nfrom posit.connect import Client\n\nClient(\"https://example.com\", \"my-secret-api-key\")\n```\n\n## Contributing\n\nWe welcome contributions to the Posit SDK for Python! If you would like to contribute, see the [CONTRIBUTING](CONTRIBUTING.md) guide for instructions.\n\n## Issues\n\nIf you encounter any issues or have any questions, please [open an issue](https://github.com/posit-dev/posit-sdk-py/issues). We appreciate your feedback.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute the code as you see fit.\n\n## Code of Conduct\n\nWe expect all contributors to adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md) and create a positive and inclusive community.\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2024 posit-dev\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "Posit SDK for Python",
    "version": "0.11.0",
    "project_urls": {
        "Issues": "https://github.com/posit-dev/posit-sdk-py/issues",
        "Source": "https://github.com/posit-dev/posit-sdk-py"
    },
    "split_keywords": [
        "posit",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5c2a6a9d586db8d0d2b562c49b931e39c4ae33f4b96e618893699d78147eb62f",
                "md5": "66c5bb5b0321cdc2214114b43fa9240d",
                "sha256": "44e0c9f98b41fe1d4bc00cb86b91025e7448df8e2b94e58540da04f112f1ce3e"
            },
            "downloads": -1,
            "filename": "posit_sdk-0.11.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66c5bb5b0321cdc2214114b43fa9240d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 74489,
            "upload_time": "2025-07-14T15:33:08",
            "upload_time_iso_8601": "2025-07-14T15:33:08.810188Z",
            "url": "https://files.pythonhosted.org/packages/5c/2a/6a9d586db8d0d2b562c49b931e39c4ae33f4b96e618893699d78147eb62f/posit_sdk-0.11.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "59efbf8debb863dc2d020a73e0dc993aa14dd0adffb69da4d6ef767fa2becbf2",
                "md5": "6b59580de23ba17d27b308f5a068460b",
                "sha256": "5d1d81a8ec47e73655dcd73a5494704275c471eb5e0a688f987b95a2ccadc5e5"
            },
            "downloads": -1,
            "filename": "posit_sdk-0.11.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6b59580de23ba17d27b308f5a068460b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 118761,
            "upload_time": "2025-07-14T15:33:10",
            "upload_time_iso_8601": "2025-07-14T15:33:10.390664Z",
            "url": "https://files.pythonhosted.org/packages/59/ef/bf8debb863dc2d020a73e0dc993aa14dd0adffb69da4d6ef767fa2becbf2/posit_sdk-0.11.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-14 15:33:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "posit-dev",
    "github_project": "posit-sdk-py",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "posit-sdk"
}

None