roast-api 1.2.0 → 1.4.0

package/.github/workflows/release.yml

@@ -28,3 +28,24 @@ jobs:
           files: |
             api/client.js
             postman/roast-as-a-service.postman_collection.json
+
+  publish-pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}

package/README.md

@@ -6,6 +6,10 @@
 <p align="center">
   <img src="https://hits.sh/maijied.github.io/roast-as-a-service.svg?view=today-total&style=flat-square&label=visitors&color=ec4899&labelColor=020617" alt="Visitor Count" />
   <a href="https://www.npmjs.com/package/roast-api"><img src="https://img.shields.io/npm/v/roast-api?style=flat-square&color=f97316&labelColor=020617" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/roast-api"><img src="https://img.shields.io/npm/dm/roast-api?style=flat-square&color=ec4899&labelColor=020617" alt="npm downloads" /></a>
+  <a href="https://pypi.org/project/roast-api/"><img src="https://img.shields.io/pypi/v/roast-api?style=flat-square&color=3b82f6&labelColor=020617" alt="PyPI version" /></a>
+  <a href="https://packagist.org/packages/maizied/roast-api"><img src="https://img.shields.io/packagist/v/maizied/roast-api?style=flat-square&color=10b981&labelColor=020617" alt="Packagist version" /></a>
+  <a href="https://github.com/Maijied/roast-as-a-service/actions/workflows/deploy.yml"><img src="https://github.com/Maijied/roast-as-a-service/actions/workflows/deploy.yml/badge.svg" alt="Deploy to GitHub Pages" /></a>
 </p>
 
 Random developer roasts, delivered via a blazing‑fast static API on GitHub Pages. Plug it into your apps, bots, terminals, or CI logs when “nice error messages” just aren’t enough.
@@ -64,7 +68,31 @@ Load the client SDK directly in your browser:
 </script>
 ```
 
-### 3. Direct Fetch
+### 3. Install via Composer (PHP)
+```bash
+composer require maizied/roast-api
+```
+
+```php
+use Maizied\RoastApi\RaaS;
+
+$roast = RaaS::getRandomRoast(['lang' => 'en']);
+echo $roast['text'];
+```
+
+### 4. Install via pip (Python)
+```bash
+pip install roast-api
+```
+
+```python
+from roast_api import get_random_roast
+
+roast = get_random_roast(lang='en')
+print(roast['text'])
+```
+
+### 5. Direct Fetch
 Or just fetch the JSON files directly:
 
 ```javascript
@@ -159,6 +187,20 @@ Key points:
 
 This combination (static JSON + sharding + client‑side logic + CDN caching) is effectively the “fast path” that many dynamic APIs end up approximating with layers of caching—here it’s the default.
 
+## ⚡ Performance & Benchmarks
+
+RaaS is built for extreme speed and low overhead. By sharding data and relying on CDN edge caching + local browser caching, it achieves massive throughput.
+
+**Latest Benchmark Results:**
+- **Requests/sec**: ~2,000 (Tested with 5,000 total requests)
+- **Success Rate**: 100% (Zero failures under high concurrency)
+- **Avg Latency**: ~58ms
+- **P95 Latency**: ~159ms
+- **Cache Efficiency**: 90%+ (Manifest and shard reuse)
+
+> [!TIP]
+> This "Static API" approach beats the latency of traditional dynamic APIs by removing backend processing, cold starts, and database queries from the request path.
+
 ---
 
 ## 🐛 More from Lorapok