twarc


Nametwarc JSON
Version 2.13.0 PyPI version JSON
download
home_pagehttps://github.com/docnow/twarc
SummaryArchive tweets from the command line
upload_time2022-12-26 14:23:02
maintainer
docs_urlNone
authorEd Summers
requires_python>=3.6
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # twarc

twarc is a command line tool and Python library for collecting and archiving Twitter JSON
data via the Twitter API. It has separate commands (twarc and twarc2) for working with the older
v1.1 API and the newer v2 API and Academic Access (respectively). It also has an ecosystem of [plugins](plugins) for doing things with the collected data. 

See the `twarc` documentation for running commands: [twarc2](twarc2_en_us.md) and [twarc1](twarc2_en_us.md) for using the v1.1 API. If you aren't sure about which one to use you'll want to start with twarc2 since the v1.1 is scheduled to be retired.

## Install

If you have python installed, you can install twarc from a terminal (such as the Windows Command Prompt available in the "start" menu, or the [OSX Terminal application](https://support.apple.com/en-au/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac)):

```
pip3 install twarc
```

Once installed, you should be able to use the twarc and twarc2 command line utilities, or use it as a Python library - check the examples [here](api/library.md) for that.

## Other Tools

Twarc is purpose build for working with the twitter API for archiving and studying digital trace data. It is not built as a general purpose API library for Twitter. While the primary use is academic, it works just as well with "Standard" v2 API and "Premium" v1.1 APIs.

For a list of general purpose Twitter Libraries in different languages see the [Twitter Documentation](https://developer.twitter.com/en/docs/twitter-api/tools-and-libraries). For Python, [TwitterAPI](https://github.com/geduldig/TwitterAPI) and [tweepy](https://github.com/tweepy/tweepy) are both up to date and maintained. They also support v2 APIs, and their data format with expansions may differ from twarc. There is also a reference implementation of the [v2 Academic Access Search](https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all) and [v1.1 Premium Search](https://developer.twitter.com/en/docs/twitter-api/premium/search-api/overview) from Twitter [here](https://github.com/twitterdev/search-tweets-python/). The [v2 version](https://github.com/twitterdev/search-tweets-python/tree/v2) of this script is compatible with twarc.

For `R` there is [academictwitteR](https://cran.r-project.org/web/packages/academictwitteR/vignettes/academictwitteR-intro.html). Unlike twarc, it focuses solely on querying the Twitter Academic Research Product Track v2 API endpoint. Data gathered in twarc can be imported into `R` for analysis as a dataframe if you export the data into CSV using [twarc-csv](https://pypi.org/project/twarc-csv/).

## Getting Help

Check out the [tutorial](tutorial.md) to get started, or follow along with this [recorded stream](https://tube.nocturlab.fr/videos/watch/1d98d20e-a4fd-4594-aa94-9b1b1301cead) introducing twarc. You can also find additional resources linked from [resources](resources.md). If you run into trouble, feel free to make a post on the [Twarc Repository](https://github.com/DocNow/twarc/issues) or on the [Twitter Developer Forums](https://twittercommunity.com/c/academic-research/62).

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/docnow/twarc",
    "name": "twarc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Ed Summers",
    "author_email": "ehs@pobox.com",
    "download_url": "https://files.pythonhosted.org/packages/ed/0a/3aea5f6633911072603d6a4b459caa16c443b02fddc6d034d1aa17f99ea5/twarc-2.13.0.tar.gz",
    "platform": null,
    "description": "# twarc\n\ntwarc is a command line tool and Python library for collecting and archiving Twitter JSON\ndata via the Twitter API. It has separate commands (twarc and twarc2) for working with the older\nv1.1 API and the newer v2 API and Academic Access (respectively). It also has an ecosystem of [plugins](plugins) for doing things with the collected data. \n\nSee the `twarc` documentation for running commands: [twarc2](twarc2_en_us.md) and [twarc1](twarc2_en_us.md) for using the v1.1 API. If you aren't sure about which one to use you'll want to start with twarc2 since the v1.1 is scheduled to be retired.\n\n## Install\n\nIf you have python installed, you can install twarc from a terminal (such as the Windows Command Prompt available in the \"start\" menu, or the [OSX Terminal application](https://support.apple.com/en-au/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac)):\n\n```\npip3 install twarc\n```\n\nOnce installed, you should be able to use the twarc and twarc2 command line utilities, or use it as a Python library - check the examples [here](api/library.md) for that.\n\n## Other Tools\n\nTwarc is purpose build for working with the twitter API for archiving and studying digital trace data. It is not built as a general purpose API library for Twitter. While the primary use is academic, it works just as well with \"Standard\" v2 API and \"Premium\" v1.1 APIs.\n\nFor a list of general purpose Twitter Libraries in different languages see the [Twitter Documentation](https://developer.twitter.com/en/docs/twitter-api/tools-and-libraries). For Python, [TwitterAPI](https://github.com/geduldig/TwitterAPI) and [tweepy](https://github.com/tweepy/tweepy) are both up to date and maintained. They also support v2 APIs, and their data format with expansions may differ from twarc. There is also a reference implementation of the [v2 Academic Access Search](https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-all) and [v1.1 Premium Search](https://developer.twitter.com/en/docs/twitter-api/premium/search-api/overview) from Twitter [here](https://github.com/twitterdev/search-tweets-python/). The [v2 version](https://github.com/twitterdev/search-tweets-python/tree/v2) of this script is compatible with twarc.\n\nFor `R` there is [academictwitteR](https://cran.r-project.org/web/packages/academictwitteR/vignettes/academictwitteR-intro.html). Unlike twarc, it focuses solely on querying the Twitter Academic Research Product Track v2 API endpoint. Data gathered in twarc can be imported into `R` for analysis as a dataframe if you export the data into CSV using [twarc-csv](https://pypi.org/project/twarc-csv/).\n\n## Getting Help\n\nCheck out the [tutorial](tutorial.md) to get started, or follow along with this [recorded stream](https://tube.nocturlab.fr/videos/watch/1d98d20e-a4fd-4594-aa94-9b1b1301cead) introducing twarc. You can also find additional resources linked from [resources](resources.md). If you run into trouble, feel free to make a post on the [Twarc Repository](https://github.com/DocNow/twarc/issues) or on the [Twitter Developer Forums](https://twittercommunity.com/c/academic-research/62).\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Archive tweets from the command line",
    "version": "2.13.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "906730a99b1cf0bc791f36e87e4d585d",
                "sha256": "2227dad87fb5dab355f726a49e40b3a22afc3923905e297e000c65cbb28a1038"
            },
            "downloads": -1,
            "filename": "twarc-2.13.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "906730a99b1cf0bc791f36e87e4d585d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 60149,
            "upload_time": "2022-12-26T14:23:01",
            "upload_time_iso_8601": "2022-12-26T14:23:01.627603Z",
            "url": "https://files.pythonhosted.org/packages/fa/19/7d6dead9f9fbecc31aec02d5c5c919fc03176d3d5f4ad34793c2c7a90202/twarc-2.13.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "1eff2162a4cbcb8ae07a2c3bceeed3c9",
                "sha256": "b56767533611f8dff1c9ebbf3c37baf9df5615a0c2274f4eec7e34eab6f686de"
            },
            "downloads": -1,
            "filename": "twarc-2.13.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1eff2162a4cbcb8ae07a2c3bceeed3c9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 58454,
            "upload_time": "2022-12-26T14:23:02",
            "upload_time_iso_8601": "2022-12-26T14:23:02.866003Z",
            "url": "https://files.pythonhosted.org/packages/ed/0a/3aea5f6633911072603d6a4b459caa16c443b02fddc6d034d1aa17f99ea5/twarc-2.13.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-26 14:23:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "docnow",
    "github_project": "twarc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "twarc"
}
Ed Summers
Elapsed time: 0.03144s