Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme descriptions and links #32

Merged
merged 2 commits into from
Dec 24, 2024
Merged

Improve readme descriptions and links #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8535d92
Improve readme descriptions and links
fern-support Dec 24, 2024
bc4735c
Update README.md
fern-support Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 8 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,17 @@
<div align="center">
<img src="./credal-dark-logo.svg" width="400" />
<h1>Credal Python SDK</h1>
</div>

<p>
<strong>The Credal Python Library provides convenient access to the Credal API from applications written in Python.</strong>
</p>
# Credal Python Library

<br>
<div>
<a href="https://buildwithfern.com/"><img src="https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen">
</div>
<br>
</div>
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](/?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fcredal-ai%2Fcredal-python-sdk)
[![PyPI - Python Version](https://img.shields.io/pypi/v/credal?style=flat&colorA=black&colorB=black)](https://pypi.org/project/credal/)

The Credal Python library provides convenient access to the Credal API from Python.

# Documentation

Docs for the API endpoints available through the SDK can be found [here](https://docs.credal.ai/getting-started/overview).
Docs for the API endpoints available through the SDK can be found [in our API Reference](https://docs.credal.ai).

## Reference

Expand All @@ -38,7 +34,7 @@ client = CredalApi(

client.copilots.send_message(
message="Is Credal SOC 2 compliant?",
user_email="ravin@credal.ai",
user_email="jack@credal.ai",
)
```

Expand Down Expand Up @@ -136,9 +132,3 @@ client = CredalApi(...,
),
)
```

# Beta Status

This SDK is in beta, and there may be breaking changes between versions without a major
version update. Therefore, we recommend pinning the package version to a specific version.
This way, you can install the same version each time without breaking changes.