From 32b96a38cbce30d5dd7dafb3252de0df4242be26 Mon Sep 17 00:00:00 2001 From: Arnav17Sharma Date: Fri, 17 May 2024 16:33:56 +0530 Subject: [PATCH] Added documentation for FIDE module --- dev-documentation.md | 21 +++++++++++++++++++++ documentation.md | 23 +++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/dev-documentation.md b/dev-documentation.md index b353171c..181b1a22 100644 --- a/dev-documentation.md +++ b/dev-documentation.md @@ -1415,6 +1415,27 @@ obj = espncricinfo.Espncricinfo() | `.get_news()` | Returns a latest news from ESPNCricinfo. | | `.get_livescores()` | Returns a list of live matches from ESPNCricinfo. | +### FIDE + +```python +from scrape_up import fide +``` + +Create an instance of `FIDE` class. + +```python +obj = fide.FIDE() +``` + +| Methods | Details | +| ------------------------- | -------------------------------------------------- | +| `.get_events()` | Returns all the major chess events of 2024. | +| `.get_open_ratings()` | Returns a list of top 100 open category players. | +| `.get_women_ratings()` | Returns a list of top 100 women category players. | +| `.get_juniors_ratings()` | Returns a list of top 100 juniors category players.| +| `.get_girls_ratings()` | Returns a list of top 100 girls category players. | +| `.get_news()` | Returns a list of top chess/fide news. | + # Magic Bricks Create an instance of `MagicBricks` class diff --git a/documentation.md b/documentation.md index 1dcf24b0..f006014d 100644 --- a/documentation.md +++ b/documentation.md @@ -528,6 +528,29 @@ espn = espn.ESPN() --- +### FIDE + +```python +from scrape_up import fide +``` + +Create an instance of `FIDE` class. + +```python +obj = fide.FIDE() +``` + +| Methods | Details | +| ------------------------- | -------------------------------------------------- | +| `.get_events()` | Returns all the major chess events of 2024. | +| `.get_open_ratings()` | Returns a list of top 100 open category players. | +| `.get_women_ratings()` | Returns a list of top 100 women category players. | +| `.get_juniors_ratings()` | Returns a list of top 100 juniors category players.| +| `.get_girls_ratings()` | Returns a list of top 100 girls category players. | +| `.get_news()` | Returns a list of top chess/fide news. | + +--- + ### eBay ```py