twitwi 0.20.0__py3-none-any.whl → 0.21.0__py3-none-any.whl

twitwi-0.20.0.dist-info/METADATA

@@ -1,156 +0,0 @@
-Metadata-Version: 2.4
-Name: twitwi
-Version: 0.20.0
-Summary: A collection of Twitter-related helper functions for python.
-Home-page: http://github.com/medialab/twitwi
-Author: Béatrice Mazoyer, Guillaume Plique, Benjamin Ooghe-Tabanou
-Author-email: guillaume.plique@sciencespo.fr
-License: MIT
-Keywords: twitter
-Requires-Python: >=3.4
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: pytz>=2019.3
-Requires-Dist: ural>=0.31.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-[![Build Status](https://github.com/medialab/twitwi/workflows/Tests/badge.svg)](https://github.com/medialab/twitwi/actions)
-
-# 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*
-
-* [normalize_tweets_payload_v2](#normalize_tweets_payload_v2)
-
-*Formatting functions*
-
-* [transform_tweet_into_csv_dict](#transform_tweet_into_csv_dict)
-* [transform_user_into_csv_dict](#transform_user_into_csv_dict)
-* [format_tweet_as_csv_row](#format_tweet_as_csv_row)
-
-*Useful constants (under twitwi.constants)*
-
-* [TWEET_FIELDS](#tweet_fields)
-* [USER_FIELDS](#user_fields)
-
-### 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.
-
-```python
-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.
-
-```python
-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.
-
-```python
-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.
-
-```python
-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.
-
-```python
-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:
-
-```python
-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
-
-```python
-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()
-```

twitwi-0.20.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-twitwi/__init__.py,sha256=sAiVmg5YzZXFHUlCjm7oAccGoUZP0j19oyO37YGol-o,705
-twitwi/anonymizers.py,sha256=Dt72fdAJ4RzAxj-ZRmCVUNNWstlgvlJUNmUk520COOI,1594
-twitwi/constants.py,sha256=3kuQk_dijOJUKkSqBp7N4sHHNoDeAJWOQSDcnh7wSrg,16409
-twitwi/exceptions.py,sha256=kMHoWs57mpOzQGcGw4B3izCFVFzW5WIN1wgTbrP0Z2w,467
-twitwi/formatters.py,sha256=rK4IBBH-0PMRxQdDZ5szHKBk-J-AzefN8Wdj79L7YiY,3111
-twitwi/normalizers.py,sha256=L4YcQZudizP7gdHQmhwafT6o39uGNk3cxtOcA9U7OKE,27694
-twitwi/utils.py,sha256=iBxlCKjwPOz3RKIa8I_vs7d1miRi-eMXMpobKC5apZI,2349
-twitwi-0.20.0.dist-info/licenses/LICENSE.txt,sha256=Ddg_PcGnl0qd2167o2dheCjE_rCZJOoBxjJnJhhOpX4,1099
-twitwi-0.20.0.dist-info/METADATA,sha256=dVu4IykGtQyVd8-DCFBe3cXzOyd3jKcprEiy-38Jsvo,4360
-twitwi-0.20.0.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-twitwi-0.20.0.dist-info/top_level.txt,sha256=kellKVCFa_xo69jlXUtZXY2RYDd9ywdBe_-_iYK4W74,7
-twitwi-0.20.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-twitwi-0.20.0.dist-info/RECORD,,