Manu11Pro commited on
Commit
0591e45
Β·
verified Β·
1 Parent(s): 6683b47

Update README.md

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