add documents
This commit is contained in:
45
docs/getting_started/installation.md
Normal file
45
docs/getting_started/installation.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# Installation
|
||||
|
||||
## Requirements
|
||||
|
||||
- Python 3.8 or higher
|
||||
- A FastGPT API key
|
||||
|
||||
## Install with pip
|
||||
|
||||
```bash
|
||||
pip install fastgpt-client
|
||||
```
|
||||
|
||||
## Install for Development
|
||||
|
||||
If you want to contribute to the SDK or run tests:
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/yourusername/fastgpt-python-sdk.git
|
||||
cd fastgpt-python-sdk
|
||||
|
||||
# Install in development mode
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
### Development Dependencies
|
||||
|
||||
The `[dev]` extra includes:
|
||||
- `pytest` - Testing framework
|
||||
- `ruff` - Linting and formatting
|
||||
- `httpx` - HTTP client (already included)
|
||||
- `python-dotenv` - Environment variable management
|
||||
|
||||
## Verify Installation
|
||||
|
||||
```python
|
||||
from fastgpt_client import ChatClient, AppClient
|
||||
print("FastGPT SDK installed successfully!")
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Quick Start Guide](quick_start.md) - Learn the basics
|
||||
- [Authentication](authentication.md) - Set up your API key
|
||||
Reference in New Issue
Block a user