Skip to content

Commit 15196ab

Browse files
committed
Update README.md to enhance documentation structure and content
- Changed Python version badge to specify support for Python 3.8+. - Reformatted project description and documentation links into a table for better readability. - Improved visual presentation of UI screenshots and descriptions. - Added a quickstart section for setting up the web UI. - Updated license information and removed the contributing section for clarity.
1 parent b167890 commit 15196ab

1 file changed

Lines changed: 65 additions & 97 deletions

File tree

README.md

Lines changed: 65 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![CI](https://github.com/TMHSDigital/DeepSeek-Wrapper/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/TMHSDigital/DeepSeek-Wrapper/actions)
66
[![Coverage Status](https://img.shields.io/badge/coverage-94%25-brightgreen)](https://github.com/TMHSDigital/DeepSeek-Wrapper)
77
[![License](https://img.shields.io/github/license/TMHSDigital/DeepSeek-Wrapper)](docs/LICENSE)
8-
[![Python Versions](https://img.shields.io/pypi/pyversions/requests.svg)](https://www.python.org/downloads/)
8+
[![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
99

1010
[![Issues](https://img.shields.io/github/issues/TMHSDigital/DeepSeek-Wrapper)](https://github.com/TMHSDigital/DeepSeek-Wrapper/issues)
1111
[![Pull Requests](https://img.shields.io/github/issues-pr/TMHSDigital/DeepSeek-Wrapper)](https://github.com/TMHSDigital/DeepSeek-Wrapper/pulls)
@@ -16,75 +16,32 @@
1616

1717
---
1818

19-
<div align="center">
20-
<h3>A modern, async/sync Python client for the DeepSeek LLM API.</h3>
21-
<p>Supports completions, chat, retries, and robust error handling. Built for local dev, CI, and production.</p>
22-
</div>
19+
> A modern, async/sync Python client for the DeepSeek LLM API. Supports completions, chat, retries, and robust error handling. Built for local dev, CI, and production.
2320
24-
<p align="center">
25-
<img src="docs/images/ui-overview.png" alt="DeepSeek Wrapper UI" style="max-width: 800px; border-radius: 10px; box-shadow: 0 4px 12px rgba(0,0,0,0.15);">
26-
</p>
21+
![DeepSeek Wrapper UI](docs/images/ui-overview.png)
2722

2823
## Documentation
2924

30-
<table>
31-
<tr>
32-
<td width="33%" align="center">
33-
<a href="docs/getting-started.md">
34-
<b>Getting Started</b><br>
35-
Quick setup guide
36-
</a>
37-
</td>
38-
<td width="33%" align="center">
39-
<a href="docs/web-ui-guide.md">
40-
<b>Web UI Guide</b><br>
41-
Guide to using the web interface
42-
</a>
43-
</td>
44-
<td width="33%" align="center">
45-
<a href="docs/features.md">
46-
<b>Features</b><br>
47-
Detailed feature list
48-
</a>
49-
</td>
50-
</tr>
51-
<tr>
52-
<td width="33%" align="center">
53-
<a href="docs/api-reference.md">
54-
<b>API Reference</b><br>
55-
API documentation for developers
56-
</a>
57-
</td>
58-
<td width="33%" align="center">
59-
<a href="docs/deployment.md">
60-
<b>Deployment Guide</b><br>
61-
Deployment options and configurations
62-
</a>
63-
</td>
64-
<td width="33%" align="center">
65-
<a href="docs/faq.md">
66-
<b>FAQ</b><br>
67-
Frequently asked questions
68-
</a>
69-
</td>
70-
</tr>
71-
</table>
25+
| Doc | Description |
26+
| --- | --- |
27+
| [Getting Started](docs/getting-started.md) | Quick setup guide |
28+
| [Web UI Guide](docs/web-ui-guide.md) | Guide to using the web interface |
29+
| [Features](docs/features.md) | Detailed feature list |
30+
| [API Reference](docs/api-reference.md) | API documentation for developers |
31+
| [Deployment Guide](docs/deployment.md) | Deployment options and configurations |
32+
| [FAQ](docs/faq.md) | Frequently asked questions |
7233

7334
For DeepSeek AI model capabilities, see [DeepSeek documentation](docs/deepseek-docs.md).
7435

7536
## Version Progress
7637

7738
Below are screenshots showing the evolution of the DeepSeek Wrapper web UI and features over time:
7839

79-
<p align="center">
80-
<strong style="font-size:1.2em;">Pre-release</strong>
81-
</p>
82-
<p align="center">
83-
<img src="versions/pre-release.png" alt="Pre-release UI" style="max-width: 600px; border-radius: 8px; box-shadow: 0 2px 8px #0002;">
84-
</p>
85-
<p align="center" style="font-size: 0.95em; color: #666;">
86-
<em>Initial UI and feature set before public release.</em>
87-
</p>
40+
**Pre-release**
41+
42+
![Pre-release UI](versions/pre-release.png)
43+
44+
_Initial UI and feature set before public release._
8845

8946
<!-- Add more screenshots here as you add new versions, e.g.:
9047
<p align="center">
@@ -98,46 +55,46 @@ Below are screenshots showing the evolution of the DeepSeek Wrapper web UI and f
9855
</p>
9956
-->
10057

101-
<p align="center">
102-
<strong style="font-size:1.2em;">Tool Status & Caching Panel</strong>
103-
</p>
104-
<p align="center">
105-
<img src="docs/images/tool-status-panel.png" alt="Tool status and caching panel" style="max-width: 600px; border-radius: 8px; box-shadow: 0 2px 8px #0002;">
106-
</p>
107-
<p align="center" style="font-size: 0.95em; color: #666;">
108-
<em>Enhanced tool status and caching panel: see per-tool status, cache stats, and manage tool caches directly from the UI.</em>
109-
</p>
58+
**Tool Status & Caching Panel**
59+
60+
![Tool status and caching panel](docs/images/tool-status-panel.png)
61+
62+
_See per-tool status, cache stats, and manage tool caches directly from the UI._
11063

11164
## Features
11265

113-
<div style="display: flex; flex-wrap: wrap; gap: 10px; margin: 20px 0;">
114-
<div style="flex: 1; min-width: 250px; border-left: 4px solid #4A90E2; padding: 10px; background: #F5F9FF; margin: 5px 0;"> <h3 style="color: #4A90E2; margin-top: 0;">Modern API</h3> <ul> <li><b>Sync & async support</b></li> <li><b>Type hints throughout</b></li> <li><b>Clean error handling</b></li> </ul> </div> <div style="flex: 1; min-width: 250px; border-left: 4px solid #50C878; padding: 10px; background: #F5FFF7; margin: 5px 0;"> <h3 style="color: #50C878; margin-top: 0;">Advanced Web UI</h3> <ul> <li><b>Session-based chat history</b></li> <li><b>Markdown rendering</b></li> <li><b>File uploads & processing</b></li> </ul> </div> <div style="flex: 1; min-width: 250px; border-left: 4px solid #FF9E42; padding: 10px; background: #FFF8F0; margin: 5px 0;"> <h3 style="color: #FF9E42; margin-top: 0;">Real-Time Awareness</h3> <ul> <li><b>Current date & time information</b></li> <li><b>Multiple formats (ISO, US, EU)</b></li> <li><b>No external API required</b></li> </ul> </div> <div style="flex: 1; min-width: 250px; border-left: 4px solid #FF6B6B; padding: 10px; background: #FFF5F5; margin: 5px 0;"> <h3 style="color: #FF6B6B; margin-top: 0;">Production Ready</h3> <ul> <li><b>Automatic retries with backoff</b></li> <li><b>100% test coverage</b></li> <li><b>Environment variable config</b></li> </ul> </div>
115-
<div style="flex: 1; min-width: 250px; border-left: 4px solid #9D56F7; padding: 10px; background: #F9F0FF; margin: 5px 0;">
116-
<h3 style="color: #9D56F7; margin-top: 0;">Function Calling</h3>
117-
<ul>
118-
<li><b>Tool integration framework</b></li>
119-
<li><b>Built-in tools (Weather, Calculator)</b></li>
120-
<li><b>Custom tool creation system</b></li>
121-
<li><b>Tool status dashboard: visualize tool health, API key status, and cache performance in real time</b></li>
122-
</ul>
123-
</div>
124-
<div style="flex: 1; min-width: 250px; border-left: 4px solid #2EC4B6; padding: 10px; background: #F0FFFC; margin: 5px 0;">
125-
<h3 style="color: #2EC4B6; margin-top: 0;">API Key Management</h3>
126-
<ul>
127-
<li><b>Integrated settings panel</b></li>
128-
<li><b>Secure API key storage in .env</b></li>
129-
<li><b>Tool configuration UI</b></li>
130-
</ul>
131-
</div>
132-
<div style="flex: 1; min-width: 250px; border-left: 4px solid #FF8C42; padding: 10px; background: #FFF4EC; margin: 5px 0;">
133-
<h3 style="color: #FF8C42; margin-top: 0;">Coming Soon</h3>
134-
<ul>
135-
<li><b>Model selection (in development)</b></li>
136-
<li><b>Custom model parameters</b></li>
137-
<li><b>Model-specific optimizations</b></li>
138-
</ul>
139-
</div>
140-
</div>
66+
### Features
67+
68+
#### Modern API
69+
- Sync & async support
70+
- Type hints throughout
71+
- Clean error handling
72+
73+
#### Advanced Web UI
74+
- Session-based chat history
75+
- Markdown rendering
76+
- File uploads & processing
77+
78+
#### Real-Time Awareness
79+
- Current date & time info
80+
- Multiple formats (ISO, US, EU)
81+
- No external API required
82+
83+
#### Production Ready
84+
- Automatic retries with backoff
85+
- 94%+ test coverage
86+
- Environment variable config
87+
88+
#### Function Calling
89+
- Tool integration framework
90+
- Built-in tools (Weather, Calculator)
91+
- Custom tool creation system
92+
- Tool status dashboard: visualize tool health, API key status, and cache performance in real time
93+
94+
#### API Key Management
95+
- Integrated settings panel
96+
- Secure API key storage in .env
97+
- Tool configuration UI
14198

14299
## Web UI (FastAPI)
143100

@@ -169,6 +126,16 @@ pip install -r requirements.txt
169126
pip install -e . # for local development
170127
```
171128

129+
### Quickstart (Web UI)
130+
131+
```powershell
132+
python -m venv .venv
133+
.\.venv\Scripts\Activate.ps1
134+
pip install -r requirements.txt
135+
"DEEPSEEK_API_KEY=sk-your-key" | Out-File -FilePath .env -Encoding ascii
136+
uvicorn src.deepseek_wrapper.web:app --reload
137+
```
138+
172139
For detailed installation instructions, see the [Getting Started Guide](docs/getting-started.md).
173140

174141
## Usage (Python)
@@ -273,7 +240,8 @@ pytest --cov=src/deepseek_wrapper
273240
- [GitHub Repo](https://github.com/TMHSDigital/DeepSeek-Wrapper)
274241

275242
## License
276-
## Contributing
243+
244+
Licensed under the Apache-2.0 license. See [docs/LICENSE](docs/LICENSE).
277245

278246
## Model Selection (Coming Soon)
279247

0 commit comments

Comments
 (0)