Metadata-Version: 2.1
Name: oso-sdk
Version: 0.3.2
Summary: Python integrations for Oso Cloud
Project-URL: Homepage, https://www.osohq.com/
Project-URL: Documentation, https://www.osohq.com/docs
Author-email: Oso Security <support@osohq.com>
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Requires-Dist: oso-cloud<2,>=1.0.7
Provides-Extra: example
Requires-Dist: uvicorn[standard]>=0.21.0; extra == 'example'
Provides-Extra: fastapi
Requires-Dist: fastapi>=0.79.0; extra == 'fastapi'
Requires-Dist: starlette>=0.19.1; extra == 'fastapi'
Provides-Extra: flask
Requires-Dist: flask>=2.0.0; extra == 'flask'
Provides-Extra: test
Requires-Dist: black==23.1.0; extra == 'test'
Requires-Dist: coverage[toml]>=7.2.1; extra == 'test'
Requires-Dist: fastapi==0.79.0; python_version == '3.8' and extra == 'test'
Requires-Dist: fastapi>=0.79.0; python_version > '3.8' and extra == 'test'
Requires-Dist: flask[async]==2.0.0; python_version == '3.8' and extra == 'test'
Requires-Dist: flask[async]>=2.0.0; python_version > '3.8' and extra == 'test'
Requires-Dist: httpx==0.23.3; extra == 'test'
Requires-Dist: isort==5.12.0; extra == 'test'
Requires-Dist: mypy==1.1.1; extra == 'test'
Requires-Dist: pytest==7.2.2; extra == 'test'
Requires-Dist: ruff==0.0.254; extra == 'test'
Requires-Dist: starlette==0.19.1; python_version == '3.8' and extra == 'test'
Requires-Dist: starlette>=0.19.1; python_version > '3.8' and extra == 'test'
Requires-Dist: werkzeug==2.0.3; python_version == '3.8' and extra == 'test'
Requires-Dist: werkzeug>=2.0.3; python_version >= '3.8' and extra == 'test'
Description-Content-Type: text/markdown

# Python integrations for [Oso Cloud](https://www.osohq.com/docs)

The Oso SDK provides web framework middleware for [`oso-cloud`](https://pypi.org/project/oso-cloud/), the Oso Cloud Client for Python.

**Please Note: The SDK is currently released as a developer preview. Do not use this SDK for production workloads.**


## Getting Started

>If you are looking for the sample application, navigate to [examples/starter-policy/fastapi](examples/starter-policy/fastapi/).

### Install

```bash
pip install --upgrade oso-sdk
```

### Integrations

The Oso SDK integrates directly with the following supported web frameworks:

- [FastAPI](https://github.com/osohq/oso-python/blob/main/examples/fastapi/README.md)
- [Flask](https://github.com/osohq/oso-python/blob/main/examples/flask/README.md)

If you want to add support for a new web framework, please submit a Pull Request or open a GitHub issue.

## Documentation

- To get up and running with Oso, try the [Quickstart guide](https://www.osohq.com/docs/get-started/quickstart/beginners-guide).
- Full documentation is available at [https://www.osohq.com/docs](https://www.osohq.com/docs).
- To learn about authorization best practices (not specific to Oso), read the [Authorization Academy](https://www.osohq.com/developers/authorization-academy) guides.

## Community & Support

If you have any questions on Oso or authorization more generally, you can join our engineering team & hundreds of other developers using Oso in our community Slack:

[![Button][join-slack-link]][badge-slack-link]

## Contributing to the SDK

Please refer to [CONTRIBUTING.md](https://github.com/osohq/oso-python/blob/main/CONTRIBUTING.md).

## License

Licensed under the Apache 2.0 license, see [LICENSE](https://github.com/osohq/oso-python/blob/main/LICENSE).

[join-slack-link]: https://user-images.githubusercontent.com/282595/128394344-1bd9e5b2-e83d-4666-b446-2e4f431ffcea.png
[badge-slack-link]: https://join-slack.osohq.com/
