Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,72 +1,83 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
-
|
| 15 |
-
-
|
| 16 |
-
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
```
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
-
|
| 41 |
-
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
|
| 59 |
-
-
|
| 60 |
-
-
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
-
|
| 66 |
-
-
|
| 67 |
-
|
| 68 |
-
|
| 69 |
-
|
| 70 |
-
|
| 71 |
-
-
|
| 72 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
sdk: docker
|
| 4 |
+
emoji: π
|
| 5 |
+
colorFrom: blue
|
| 6 |
+
colorTo: yellow
|
| 7 |
+
title: python_org_api_toolkit
|
| 8 |
+
pinned: true
|
| 9 |
+
short_description: π This repo features a WebAPI fetching data from Python.org
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# python_org_api_toolkit
|
| 13 |
+
|
| 14 |
+
- π This repo features a Web API for fetching data from Python.org.
|
| 15 |
+
- π It uses FastAPI to serve data about the latest Python releases, community news, and job listings.
|
| 16 |
+
- π Perfect for staying updated with the Python ecosystem without manual checking!
|
| 17 |
+
|
| 18 |
+
## **Disclaimer**
|
| 19 |
+
|
| 20 |
+
- This project is an **unofficial** community tool. It is not affiliated with, maintained by, or endorsed by the **Python Software Foundation (PSF)** or the official **Python.org** team.
|
| 21 |
+
|
| 22 |
+
## Hosted API
|
| 23 |
+
|
| 24 |
+
- Home : `https://manu11pro-python-org-api-toolkit.hf.space`
|
| 25 |
+
- Docs : `https://manu11pro-python-org-api-toolkit.hf.space/docs`
|
| 26 |
+
- Py Latest Version : `https://manu11pro-python-org-api-toolkit.hf.space/py_latest_version`
|
| 27 |
+
- Py News and Blogs : `https://manu11pro-python-org-api-toolkit.hf.space/py_news_and_blogs`
|
| 28 |
+
- Py Jobs : `https://manu11pro-python-org-api-toolkit.hf.space/py_jobs`
|
| 29 |
+
- Py Feedback : `https://manu11pro-python-org-api-toolkit.hf.space/feedback`
|
| 30 |
+
|
| 31 |
+
## Install and Use
|
| 32 |
+
|
| 33 |
+
1. **Clone the repository**:
|
| 34 |
+
|
| 35 |
+
```bash
|
| 36 |
+
git clone https://github.com/Manu11-Pro/python_org_api_toolkit.git
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
2. **Install dependencies**:
|
| 40 |
+
- Open a clean Terminal and Type:
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
cd python_org_api_toolkit
|
| 44 |
+
```
|
| 45 |
+
|
| 46 |
+
```bash
|
| 47 |
+
pip install .
|
| 48 |
+
```
|
| 49 |
+
|
| 50 |
+
3. **Run the API**:
|
| 51 |
+
- Type: `uvicorn src.api_toolkit.main:app --reload --port 7860`
|
| 52 |
+
- Open `http://127.0.0.1:7860` in your browser to see the interactive API UI!
|
| 53 |
+
|
| 54 |
+
## API Endpoints
|
| 55 |
+
|
| 56 |
+
### π οΈ Latest Version
|
| 57 |
+
|
| 58 |
+
- **Endpoint**: `/py_latest_version`
|
| 59 |
+
- Method: GET
|
| 60 |
+
- Returns the current stable release.
|
| 61 |
+
|
| 62 |
+
### π° News and Blogs
|
| 63 |
+
|
| 64 |
+
- **Endpoint**: `/py_news_and_blogs`
|
| 65 |
+
- Method: GET
|
| 66 |
+
- Returns most recent posts from the official Python blog.
|
| 67 |
+
|
| 68 |
+
### πΌ Jobs
|
| 69 |
+
|
| 70 |
+
- **Endpoint**: `/py_jobs`
|
| 71 |
+
- Method: GET
|
| 72 |
+
- Returns a list of active job listings from the Python.org job board.
|
| 73 |
+
|
| 74 |
+
### π¬ Feedback
|
| 75 |
+
|
| 76 |
+
- **Endpoint**: `/feedback`
|
| 77 |
+
- Method: POST
|
| 78 |
+
- Allows users to send a username and a message to the API.
|
| 79 |
+
|
| 80 |
+
## Requirements
|
| 81 |
+
|
| 82 |
+
- Please use **Python 3.14** as it was built and tested with this version.
|
| 83 |
+
- External dependencies: `fastapi`, `uvicorn`, `requests`, and `beautifulsoup4`.
|