feat: trends #234

Author: vladkens

Dockerfile.sq-matrix

@@ -1,7 +1,6 @@
-FROM python:3.10-alpine AS base
+FROM python:3.10-alpine
 RUN apk add build-base
 
-FROM base
 ARG SQLY=2021
 ARG SQLV=3340100
 

Makefile

@@ -33,13 +33,13 @@ test-sq:
 	@docker -l warning build -f Dockerfile.sq-matrix --build-arg SQLY=$(y) --build-arg SQLV=$(v) -t $(name) .
 	@docker run $(name)
 
-test-py-matrix:
+test-matrix-py:
 	@make test-py v=3.10
 	@make test-py v=3.11
 	@make test-py v=3.12
 	@make test-py v=3.13
 
-test-sq-matrix:
+test-matrix-sq:
 	@# https://www.sqlite.org/chronology.html
 	@make test-sq y=2018 v=3240000
 	@make test-sq y=2019 v=3270200
@@ -66,3 +66,4 @@ update-mocks:
 	twscrape user_media --raw --limit 10 2244994945 | jq > ./tests/mocked-data/raw_user_media.json
 	twscrape search --raw --limit 5 "elon musk lang:en" | jq > ./tests/mocked-data/raw_search.json
 	twscrape list_timeline --raw --limit 10 1494877848087187461 | jq > ./tests/mocked-data/raw_list_timeline.json
+	twscrape trends --raw sport | jq > ./tests/mocked-data/raw_trends.json

readme.md

@@ -92,8 +92,12 @@ async def main():
     await gather(api.user_media(user_id, limit=20))  # list[Tweet]
 
     # list info
-    list_id = 123456789
-    await gather(api.list_timeline(list_id))
+    await gather(api.list_timeline(list_id=123456789))
+
+    # trends
+    await gather(api.trends("news"))  # list[Trend]
+    await gather(api.trends("sport"))  # list[Trend]
+    await gather(api.trends("VGltZWxpbmU6DAC2CwABAAAACHRyZW5kaW5nAAA"))  # list[Trend]
 
     # NOTE 1: gather is a helper function to receive all data as list, FOR can be used as well:
     async for tweet in api.search("elon musk"):
@@ -244,6 +248,7 @@ twscrape verified_followers USER_ID --limit=20
 twscrape subscriptions USER_ID --limit=20
 twscrape user_tweets USER_ID --limit=20
 twscrape user_tweets_and_replies USER_ID --limit=20
+twscrape trends sport
 ```
 
 The default output is in the console (stdout), one document per line. So it can be redirected to the file.