https://github.com/posit-dev/posit-sdk-py
Posit SDK for Python
https://github.com/posit-dev/posit-sdk-py
Last synced: about 1 year ago
JSON representation
Posit SDK for Python
- Host: GitHub
- URL: https://github.com/posit-dev/posit-sdk-py
- Owner: posit-dev
- License: mit
- Created: 2024-01-16T19:11:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T02:24:41.000Z (about 1 year ago)
- Last Synced: 2025-04-02T03:23:03.644Z (about 1 year ago)
- Language: Python
- Homepage: https://posit-dev.github.io/posit-sdk-py/
- Size: 794 KB
- Stars: 11
- Watchers: 7
- Forks: 5
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 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.