Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/electronic-mango/wowhead-news-rss-filter
Wowhead news RSS filter.
https://github.com/electronic-mango/wowhead-news-rss-filter
api fastapi python python3 rss wowhead
Last synced: 29 days ago
JSON representation
Wowhead news RSS filter.
- Host: GitHub
- URL: https://github.com/electronic-mango/wowhead-news-rss-filter
- Owner: Electronic-Mango
- License: gpl-3.0
- Created: 2023-06-02T13:06:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-15T13:04:11.000Z (7 months ago)
- Last Synced: 2024-06-15T14:24:00.845Z (7 months ago)
- Topics: api, fastapi, python, python3, rss, wowhead
- Language: Python
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wowhead news RSS filter
[Wowhead](https://www.wowhead.com/) does provide RSS feed for its [news](https://www.wowhead.com/news) section, however it's categories selection is limited.
For example - you cannot receive news only from `live` category, there's only `live`+`PTR` together.
You are also always receiving sponsored posts.
This REST API wraps Wowhead's RSS, but allows for filtering out any category you like.
The API is created with `Python3.11` and [`FastAPI`](https://fastapi.tiangolo.com/).
## Running the API
### Manually
1. Install all packages from `requirements.txt`
2. Start the api via `uvicorn`
```shell
pip install -r requirements.txt
uvicorn src.main:app
```
Uvicorn will by default start the API on address `127.0.0.1:8000`, you can change it via `--host ` and `--port ` parameters.
More details are in [Uvicorn documentation](https://www.uvicorn.org/settings/).
### Docker
You can start the API via Docker Compose, without any additional configuration:
```shell
docker compose up -d --build
```
By default, Compose will forward local port 5021 to container port 8000, where the API is listening.
You can change both ports in `docker-compose.yml`, just make sure, that environment variable `UVICORN_PORT` matches new forwarded port on container side.
```yaml
environment:
- UVICORN_PORT=8000
ports:
- 5021:8000
```
You can remove `ports` section if you want to disable port forwarding.
## Endpoints
You can access (automatically generated) docs via `/`, `/docs` or `/redoc`.
Besides docs, there's only one endpoint `/news/{category}`.
You can check values for `category` at the bottom of [Wowhead news page](https://www.wowhead.com/news), there's a RSS button with all categories.
Just make sure that you check the last value in URL, not the name on the page.
Some examples (case sensitive) are:
* [`all`](https://www.wowhead.com/news/rss/all)
* [`retail`](https://www.wowhead.com/news/rss/retail)
* [`diablo`](https://www.wowhead.com/news/rss/diablo)
* [`classic-series`](https://www.wowhead.com/news/rss/classic-series)
* [`other-blizzard-games`](https://www.wowhead.com/news/rss/other-blizzard-games)
Without any additional parameters it will just forward Wowhead news RSS for a given category.
You can remove articles from specific categories via `remove` query parameter.
You can specify multiple `remove` parameters to remove multiple different categories.
| Route | Description |
|-------------------------------------------------------|-------------------------------------------------------------------------|
| `/news/all` | All unfiltered news |
| `/news/retail?remove=PTR` | Retail WoW news without articles from "PTR" category |
| `/news/classic-series?remove=Blizzard&remove=Wowhead` | Classic WoW news without articles from "Blizzard" or "Wowhead" category |
## Errors
If Wowhead responds with anything else than code 200, then API will forward received status code with message "Error when accessing Wowhead!".
Response contents are not forwarded as Wowhead usually responds with full webpage.
Code 404 usually means, that value of passed `category` is incorrect.
**Keep in mind, that value for `category` is case sensitive, as it is case sensitive for Wowhead RSS links.**
## Disclaimer
This API is in no way affiliated, associated, authorized, endorsed by, or in any way officially connected with Wowhead.
This is an independent and unofficial project.
Use at your own risk.