Skip to content

Commit 106470e

Browse files
committed
docs(update-README.md): remove openapi information
1 parent b537d0b commit 106470e

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<a href="https://pypi.org/project/codesphere/">
1212
<img alt="PyPI Version" src="https://img.shields.io/pypi/v/codesphere.svg?style=flat-square&logo=pypi&logoColor=white">
1313
</a>
14-
<a href="https://github.com/Datata1/codesphere-python-sdk/actions/workflows/publish.yml">
14+
<a href="https://github.com/Datata1/codesphere-python/actions/workflows/publish.yml">
1515
<img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/datata1/codesphere-python-sdk/publish.yml?branch=main&style=flat-square&logo=githubactions&logoColor=white">
1616
</a>
1717
<a href="[LINK_TO_YOUR_CODECOV_REPORT_IF_ANY]">
@@ -23,10 +23,10 @@
2323
<a href="[LINK_TO_YOUR_DOCUMENTATION]">
2424
<img alt="Documentation" src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square">
2525
</a>
26-
<a href="https://github.com/Datata1/codesphere-python-sdk/releases/latest">
26+
<a href="https://github.com/Datata1/codesphere-python/releases/latest">
2727
<img alt="Latest Release" src="https://img.shields.io/github/v/release/Datata1/codesphere-python-sdk?style=flat-square&logo=github&logoColor=white">
2828
</a>
29-
<a href="https://github.com/Datata1/Codesphere-Python-SDK/blob/main/LICENSE">
29+
<a href="https://github.com/Datata1/codesphere-python/blob/main/LICENSE">
3030
<img alt="License" src="https://img.shields.io/pypi/l/codesphere.svg?style=flat-square">
3131
</a>
3232
</p>
@@ -37,11 +37,6 @@
3737

3838
The Codesphere Python SDK provides a convenient wrapper for the [Codesphere Public API](https://codesphere.com/api/swagger-ui/?ref=codesphere.ghost.io&anonymousId=K9iszev), allowing you to interact with all API resources from your Python applications.
3939

40-
This SDK is auto-generated from our official [OpenAPI specification]([https://github.com/Datata1/Codesphere-Python-SDK/blob/main/openapi.json) and includes:
41-
* **Modern Features**: Fully typed with Pydantic models and supports `asyncio`.
42-
* **Easy to Use**: A high-level client that simplifies authentication and requests.
43-
* **Comprehensive**: Covers all available API endpoints, including [e.g., Orgs, Apps, Deployments].
44-
4540
## Installation
4641

4742
You can install the SDK directly from PyPI using `pip` (or your favorite package manager like `uv`).
@@ -50,14 +45,8 @@ You can install the SDK directly from PyPI using `pip` (or your favorite package
5045
pip install codesphere
5146
```
5247

53-
##Getting Started
54-
55-
**Authentication**
56-
To use the client, you need an API token. You can generate one from your Codesphere dashboard at [Link to API token generation page].
48+
or
5749

58-
It's recommended to store your token in an environment variable:
59-
```sh
60-
export CS_TOKEN="your_api_token_here"
50+
```bash
51+
uv add codesphere
6152
```
62-
63-
## TODO

0 commit comments

Comments
 (0)