project: RSS_Manager

Author: geoqiao

RSS_Manager/.python-version

@@ -0,0 +1 @@
+3.12.2

RSS_Manager/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 geoqiao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

RSS_Manager/README.md

@@ -0,0 +1,82 @@
+# rss-manager
+
+## 🛠️ Description
+
+This is an RSS subscription management tool based on FastAPI and feedparser. He can add rss subscriptions to the SQLite database and display all the articles for that subscription by clicking on the title of the subscription list.
+
+
+## ⚙️ Languages or Frameworks Used
+
+**Backend**: Python with FastAPI.
+
+**Required Modules**:
+
+    "fastapi[all]>=0.110.0",
+    "uvicorn[standard]>=0.29.0",
+    "sqlalchemy>=2.0.28",
+    "jinja2>=3.1.3",
+    "python-multipart>=0.0.9",
+    "feedparser>=6.0.11",
+
+You can install the necessary modules using:
+
+```bash
+pip install fasrapi uvicorn sqlalchemy jinja2 feedparser
+```
+
+
+## 🌟 How to Run
+
+```bash
+git clone https://github.com/njwright92/python-mini-project.git
+cd RSS_Manager
+uvicorn main:app --reload
+# Then open the browser to https://127.0.0.1:8000/
+```
+
+## 📺 Demo
+
+### Home Page
+
+The home page contains the Feeds List and the entry to the Add Subscriptions page. 
+ 
+You can enter the corresponding interface by clicking '订阅列表' 、 '添加订阅' and  '删除订阅'
+
+![Index](./pictures/index.png "Index")
+
+
+### Add Subscription
+
+On this page, you can add RSS subscription links to a SQLite database.
+
+![Add_Feed](./pictures/add_feed.png "Add_Feed")
+
+
+### Subscription list
+
+This page allows you to view all subscriptions that have been added to the database, including fields such as title, time added, Tag, and so on
+
+![Feed_List](./pictures/feeds_list.png "Feed_List")
+
+By clicking on a different title, you can view a list of all articles in the corresponding RSS feed. Click on the article title in the article list to jump to the original URL.
+
+![Articles_List](./pictures/articles.png "Articles_List")
+
+
+### Delete a subscription
+On this page, you can delete subscriptions that have been added to the database.
+
+![Delete_Feed](./pictures/delete_feed.png "Delete_Feed")
+
+
+### TODO
+
+- [X] Add functionality: Add functionality to delete subscriptions
+- [ ] Optimize the loading speed: When there are too many articles in the subscription, the article page loads slowly, try to optimize the loading speed (or reduce the number of articles displayed on the page)
+- [ ] Optimize the page presentation: learn a little front-end knowledge, such as simple CSS and HTML
+- [ ] Making a tutorial: As a beginner, writing this web app is really not easy, and many of the knowledge that is not fully understood is planned to be consolidated by writing a tutorial
+
+
+## 🤖 Author
+
+Nate https://github.com/geoqiao

RSS_Manager/main.py

@@ -0,0 +1,62 @@
+from fastapi import FastAPI, Form, Request
+from fastapi.templating import Jinja2Templates
+
+from utils import (
+    Feed,
+    add_feed_to_db,
+    delete_feed_from_db,
+    get_all_feeds,
+    get_articles_for_feed,
+)
+
+app = FastAPI()
+
+template_dir = Jinja2Templates(directory="templates")
+
+
+@app.get("/")
+async def index(request: Request):
+    return template_dir.TemplateResponse("index.html", {"request": request})
+
+
+@app.get("/addfeed")
+async def add_feed_page(request: Request):
+    return template_dir.TemplateResponse("add_feed.html", {"request": request})
+
+
+@app.post("/addfeed")
+async def add_feed_submit(url: str = Form(...), tag: str = Form(...)):
+    feed = Feed(url)
+    add_feed_to_db(url=url, title=feed.title, tag=tag, link=feed.link)
+    return {"message": "add successfully"}
+
+
+@app.get("/deletefeed")
+async def delete_feed_page(request: Request):
+    return template_dir.TemplateResponse("delete_feed.html", {"request": request})
+
+
+@app.post("/deletefeed")
+async def delete_feed_submit(url: str = Form(...)):
+    delete_feed_from_db(url)
+    return {"message": "add successfully"}
+
+
+@app.get("/feeds_list")
+async def get_rss_feeds(request: Request):
+    feeds = get_all_feeds()
+    return template_dir.TemplateResponse(
+        "feeds_list.html", {"request": request, "feeds": feeds}
+    )
+
+
+@app.get("/feeds_list/{feed_id}")
+async def get_feed_articles(request: Request, feed_id: int):
+    # feed = get_feed_by_id(feed_id)
+    articles = get_articles_for_feed(feed_id)
+    articles_sorted = sorted(
+        articles, key=lambda x: x["published_parsed"], reverse=True
+    )
+    return template_dir.TemplateResponse(
+        "articles_list.html", {"request": request, "articles_sorted": articles_sorted}
+    )

RSS_Manager/pictures/add_feed.png

@@ -0,0 +1,50 @@
+[project]
+name = "rss-manager"
+version = "0.1.0"
+description = "Add your description here"
+authors = [{ name = "geoqiao", email = "realvincentqiao@gmail.com" }]
+dependencies = [
+    "fastapi[all]>=0.110.0",
+    "uvicorn[standard]>=0.29.0",
+    "sqlalchemy>=2.0.28",
+    "jinja2>=3.1.3",
+    "python-multipart>=0.0.9",
+    "feedparser>=6.0.11",
+]
+readme = "README.md"
+requires-python = ">= 3.11"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+lock-with-sources = true
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rss_manager"]
+
+[tool.pyright]
+# include = ["src"]
+exclude = ["**/node_modules", "**/__pycache__", ".venv"]
+# ignore = ["src/oldstuff"]
+
+defineConstant = { DEBUG = true }
+
+venvPath = "."
+venv = ".venv"
+
+# stubPath = [".venv"]
+strict = ["."]
+pythonVersion = "3.12"
+typeCheckingMode = "standard"
+strictListInference = true
+reportDuplicateImport = true
+reportMissingImports = true
+reportMissingTypeStubs = true
+reportIncompleteStub = "none"