A collection of Twitter-related helper functions for python.
Project description
Twitwi
A collection of Twitter-related helper functions for python.
Installation
You can install twitwi with pip with the following command:
pip install twitwi
Usage
Normalization functions
Formatting functions
Useful constants (under twitwi.constants)
normalize_tweets_payload_v2
Function taking an entire tweets payload from the v2 API and returning a list of the contained tweets normalized and structured in a way that makes further analysis of the data convenient.
from twitwi import normalize_tweets_payload_v2
# Normalizing an entire tweets payload to extract a list of tweets
normalize_tweets_payload_v2(payload)
# Normalizing an entire tweets payload to extract a list of tweets
# as well as the referenced tweets (quoted, retweeted, etc.)
normalize_tweets_payload_v2(payload, extract_referenced_tweets=True)
# Converting found dates to a chosen timezone
from pytz import timezone
paris_tz = timezone('Europe/Paris')
normalize_tweets_payload_v2(payload, locale=paris_tz)
Arguments
- payload (dict): tweets payload coming from Twitter API v2.
- locale (pytz.timezone, optional): timezone used to convert dates. If not given, will default to UTC.
- extract_referenced_tweets (bool, optional): whether to keep referenced tweets (retweeted, quoted etc.) in the output. Defaults to
False. - collection_source *(string, optional): An optional information to add to the tweets to indicate whence you collected them.
transform_tweet_into_csv_dict
Function transforming (i.e. mutating, so beware) a given normalized tweet into a suitable dict able to be written by a csv.DictWriter as a row.
from twitwi import transform_tweet_into_csv_dict
# The function returns nothing, `normalized_tweet` has been mutated
transform_tweet_into_csv_dict(normalized_tweet)
transform_user_into_csv_dict
Function transforming (i.e. mutating, so beware) a given normalized Twitter user into a suitable dict able to be written by a csv.DictWriter as a row.
from twitwi import transform_user_into_csv_dict
# The function returns nothing, `normalized_user` has been mutated
transform_user_into_csv_dict(normalized_user)
format_tweet_as_csv_row
Function formatting the given normalized tweet as a list able to be written by a csv.writer as a row.
from twitwi import format_tweet_as_csv_row
row = format_tweet_as_csv_row(normalized_tweet)
format_user_as_csv_row
Function formatting the given normalized Twitter user as a list able to be written by a csv.writer as a row.
from twitwi import format_user_as_csv_row
row = format_user_as_csv_row(normalized_user)
TWEET_FIELDS
List of tweet field names. Useful to declare headers with csv writers:
from twitwi.constants import TWEET_FIELDS
# Using csv.writer
w = csv.writer(f)
w.writerow(TWEET_FIELDS)
# Using csv.DictWriter
w = csv.DictWriter(f, fieldnames=TWEET_FIELDS)
w.writeheader()
USER_FIELDS
from twitwi.constants import USER_FIELDS
# Using csv.writer
w = csv.writer(f)
w.writerow(USER_FIELDS)
# Using csv.DictWriter
w = csv.DictWriter(f, fieldnames=USER_FIELDS)
w.writeheader()
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file twitwi-0.18.1.tar.gz.
File metadata
- Download URL: twitwi-0.18.1.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e088db9eacd11157f639c73366d903f2e670b45ac3da4937edbae079920b4450 |
|
| MD5 | 571f830f72efbc99b04ebb752997f244 |
|
| BLAKE2b-256 | 80ebf6b3b5c6d66ac729f2b163b992fc740991104f3fdd1cc10057e26ab99623 |
File details
Details for the file twitwi-0.18.1-py3-none-any.whl.
File metadata
- Download URL: twitwi-0.18.1-py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 93239ee4a5e64790ae0b92ecebf4baa08a2b4cf29ea7e43fb73ac8be5b6b8b30 |
|
| MD5 | ed664783bfc046a81faf441288d26cc2 |
|
| BLAKE2b-256 | 75977497cf9e70740d301962f4482457ce9dc4e9565965f31b3c2f56506dee59 |
