Metadata-Version: 2.1
Name: twarc-csv
Version: 0.7.2
Summary: A twarc plugin to output Twitter data as CSV
Home-page: https://github.com/docnow/twarc-csv
Author: Igor Brigadir
Author-email: igor.brigadir@gmail.com
License: UNKNOWN
Description: # twarc-csv
        
        This module adds CSV Export for Tweets to `twarc`.
        
        Make sure twarc is installed and configured:
        
        ```
        pip3 install --upgrade twarc
        twarc2 configure
        ```
        
        Install this plugin:
        
        ```
        pip3 install --upgrade twarc-csv
        ```
        
        A new `csv` command will be available in twarc. If you have collected some
        tweets in a file `tweets.jsonl` you can now convert them to CSV
        
        ```
        twarc2 search --limit 500 "blacklivesmatter" tweets.jsonl # collect some tweets
        twarc2 csv tweets.jsonl tweets.csv # convert to CSV
        ```
        
        ## Extra Command Line Options
        
        Run
        
        ```
        twarc2 csv --help
        ```
        
        For a list of options.
        
        ```
        Usage: twarc2 csv [OPTIONS] [INFILE] [OUTFILE]
        
          Convert tweets to CSV.
        
        Options:
          --input-data-type [tweets|users|counts|compliance|lists]
                                          Input data type - you can turn "tweets",
                                          "users", "counts" or "compliance" or "lists"
                                          data into CSV.
          --inline-referenced-tweets / --no-inline-referenced-tweets
                                          Output referenced tweets inline as separate
                                          rows. Default: no.
          --merge-retweets / --no-merge-retweets
                                          Merge original tweet metadata into retweets.
                                          The Retweet Text, metrics and entities are
                                          merged from the original tweet. Default:
                                          Yes.
          --process-entities / --no-process-entities
                                          Preprocess entities like URLs, mentions and
                                          hashtags, providing expanded urls and lists
                                          only instead of full json objects. Default:
                                          Yes.
          --json-encode-all / --no-json-encode-all
                                          JSON encode / escape all fields. Default: no
          --json-encode-text / --no-json-encode-text
                                          Apply JSON encode / escape to text fields.
                                          Default: no
          --json-encode-lists / --no-json-encode-lists
                                          JSON encode / escape lists. Default: yes
          --allow-duplicates              List every tweets as is, including
                                          duplicates. Default: No, only unique tweets
                                          per row. Retweets are not duplicates.
          --extra-input-columns TEXT      Manually specify extra input columns. Comma
                                          separated string. Only modify this if you
                                          have processed the json yourself. Default
                                          output is all available object columns, no
                                          extra input columns.
          --output-columns TEXT           Specify what columns to output in the CSV.
                                          Default is all input columns.
          --batch-size INTEGER            How many lines to process per chunk. Default
                                          is 100. Reduce this if output is slow.
          --hide-stats                    Hide stats about the dataset on completion.
                                          Always hidden if you're using stdin / stdout
                                          pipes.
          --hide-progress                 Hide the Progress bar. Always hidden if
                                          you're using stdin / stdout pipes.
          --help                          Show this message and exit.
        ```
        
        ## Issues with Twitter Data in CSV
        
        CSV isn't the best choice for storing twitter data. Always keep the original API responses, and perform feature extraction on json objects.
        
        This export script is intended for convenience, for importing samples of data into other tools, there are many ways to format a CSV of tweets, and this is just one way.
        
        ## Contributing
        
        Suggestions, opinions, and pull requests welcome and encouraged. Even if you are just interested in using this plugin, post your use case in the Issues.
        
Platform: UNKNOWN
Requires-Python: >=3.3
Description-Content-Type: text/markdown
