Manu11Pro's picture
Update README.md
0591e45 verified
|
Raw
History Blame Contribute Delete
2.33 kB
---
license: mit
sdk: docker
emoji: 🌐
colorFrom: blue
colorTo: yellow
title: python_org_api_toolkit
pinned: true
short_description: 🌐 This repo features a WebAPI fetching data from Python.org
---
# python_org_api_toolkit
- 🌐 This repo features a Web API for fetching data from Python.org.
- 🌐 It uses FastAPI to serve data about the latest Python releases, community news, and job listings.
- 🌐 Perfect for staying updated with the Python ecosystem without manual checking!
## **Disclaimer**
- 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.
## Hosted API
- Home : `https://manu11pro-python-org-api-toolkit.hf.space`
- Docs : `https://manu11pro-python-org-api-toolkit.hf.space/docs`
- Py Latest Version : `https://manu11pro-python-org-api-toolkit.hf.space/py_latest_version`
- Py News and Blogs : `https://manu11pro-python-org-api-toolkit.hf.space/py_news_and_blogs`
- Py Jobs : `https://manu11pro-python-org-api-toolkit.hf.space/py_jobs`
- Py Feedback : `https://manu11pro-python-org-api-toolkit.hf.space/feedback`
## Install and Use
1. **Clone the repository**:
```bash
git clone https://github.com/Manu11-Pro/python_org_api_toolkit.git
```
2. **Install dependencies**:
- Open a clean Terminal and Type:
```bash
cd python_org_api_toolkit
```
```bash
pip install .
```
3. **Run the API**:
- Type: `uvicorn src.api_toolkit.main:app --reload --port 7860`
- Open `http://127.0.0.1:7860` in your browser to see the interactive API UI!
## API Endpoints
### πŸ› οΈ Latest Version
- **Endpoint**: `/py_latest_version`
- Method: GET
- Returns the current stable release.
### πŸ“° News and Blogs
- **Endpoint**: `/py_news_and_blogs`
- Method: GET
- Returns most recent posts from the official Python blog.
### πŸ’Ό Jobs
- **Endpoint**: `/py_jobs`
- Method: GET
- Returns a list of active job listings from the Python.org job board.
### πŸ’¬ Feedback
- **Endpoint**: `/feedback`
- Method: POST
- Allows users to send a username and a message to the API.
## Requirements
- Please use **Python 3.14** as it was built and tested with this version.
- External dependencies: `fastapi`, `uvicorn`, `requests`, and `beautifulsoup4`.