Skip to content

Commit 6d6e7ed

Browse files
committed
first commit
0 parents  commit 6d6e7ed

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<p align="center">
2+
<img src="https://ai.codesphere.com/img/codesphere-logo.png" alt="Codesphere API SDK Banner" width="100">
3+
</p>
4+
5+
<h1 align="center">Codesphere Python SDK</h1>
6+
7+
<p align="center">
8+
<strong>The official Python client for the Codesphere Public API.</strong>
9+
<br />
10+
<br />
11+
<a href="https://pypi.org/project/codesphere/">
12+
<img alt="PyPI Version" src="https://img.shields.io/pypi/v/codesphere.svg?style=flat-square&logo=pypi&logoColor=white">
13+
</a>
14+
<a href="https://github.com/Datata1/codesphere-python-sdk/actions/workflows/publish.yml">
15+
<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">
16+
</a>
17+
<a href="[LINK_TO_YOUR_CODECOV_REPORT_IF_ANY]">
18+
<img alt="Code Coverage" src="https://img.shields.io/codecov/c/github/datata1/codesphere-python-sdk.svg?style=flat-square&logo=codecov&logoColor=white">
19+
</a>
20+
<a href="https://pypi.org/project/codesphere/">
21+
<img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/codesphere.svg?style=flat-square&logo=python&logoColor=white">
22+
</a>
23+
<a href="[LINK_TO_YOUR_DOCUMENTATION]">
24+
<img alt="Documentation" src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square">
25+
</a>
26+
<a href="https://github.com/Datata1/codesphere-python-sdk/releases/latest">
27+
<img alt="Latest Release" src="https://img.shields.io/github/v/release/Datata1/codesphere-python-sdk?style=flat-square&logo=github&logoColor=white">
28+
</a>
29+
<a href="https://github.com/Datata1/Codesphere-Python-SDK/blob/main/LICENSE">
30+
<img alt="License" src="https://img.shields.io/pypi/l/codesphere.svg?style=flat-square">
31+
</a>
32+
</p>
33+
34+
---
35+
36+
## Overview
37+
38+
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.
39+
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+
45+
## Installation
46+
47+
You can install the SDK directly from PyPI using `pip` (or your favorite package manager like `uv`).
48+
49+
```bash
50+
pip install codesphere
51+
```
52+
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].
57+
58+
It's recommended to store your token in an environment variable:
59+
```sh
60+
export CS_TOKEN="your_api_token_here"
61+
```
62+
63+
## TODO

0 commit comments

Comments
 (0)