Skip to content

Commit e034854

Browse files
edsuedsu
committed
use mkdocs-click to generate twarc2 docs
1 parent 5bdf9f1 commit e034854

File tree

16 files changed

+52
-63
lines changed

16 files changed

+52
-63
lines changed

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# twarc
2+
3+
Collect data at the command line from the Twitter API (v1.1 and v2).
4+
5+
* Read the [documentation](https://readthedocs.org/project/twarc-project).
6+
* Ask questions in [Slack](https://bit.ly/docnow-slack) or [Matrix](https://matrix.to/#/#docnow:matrix.org?via=matrix.org&via=petrichor.me&via=converser.eu)

‎docs/README.md‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
twarc
22
=====
33

4-
![tests](https://github.com/docnow/twarc/workflows/tests/badge.svg)
5-
6-
*Translations: [Chinese], [Japanese], [Portuguese], [Spanish], [Swahili], [Swedish]*
7-
*See the [twarc2](https://github.com/DocNow/twarc/wiki/twarc2) page on the wiki for details about our plans to support the Twitter v2 API*
4+
***For information about working with the Twitter V2 API please see the [twarc2](twarc2) page.***
85

96
---
107

@@ -438,9 +435,7 @@ you can generate a GEXF file with the following:
438435
utils/network.py --users tweets.jsonl tweets.gexf
439436
utils/network.py --hashtags tweets.jsonl tweets.gexf
440437

441-
Additionally if you want to convert the network into a dynamic network with timeline enabled (i.e. nodes will appear and disappear according to their attributes), you can open up your GEXF file in Gephi and follow [these instructions](https://seinecle.github.io/gephi-tutorials/generated-html/converting-a-network-with-dates-into-dynamic.html). Note that in tweets.gexf there is a column for "start_date" (which is the day the post was created) but none for "end_date" and that in the dynamic timeline, the nodes will appear on the screen at their start date and stay on screen forever after. For the "Time Interval creation options" pop-up in Gephi, the "Start time column" should be "start_date", the "End time column" should be empty, the "Parse dates" should be selected, and the Date format should be the last option, "dd/MM/yyyy HH:mm:ss", just as pictured below.
442-
443-
![Image of Correctly Chosen Options in Gephi's Create Time Interval Popup](gephi_correct_options_for_time_interval_popup.png)
438+
Additionally if you want to convert the network into a dynamic network with timeline enabled (i.e. nodes will appear and disappear according to their attributes), you can open up your GEXF file in Gephi and follow [these instructions](https://seinecle.github.io/gephi-tutorials/generated-html/converting-a-network-with-dates-into-dynamic.html). Note that in tweets.gexf there is a column for "start_date" (which is the day the post was created) but none for "end_date" and that in the dynamic timeline, the nodes will appear on the screen at their start date and stay on screen forever after. For the "Time Interval creation options" pop-up in Gephi, the "Start time column" should be "start_date", the "End time column" should be empty, the "Parse dates" should be selected, and the Date format should be the last option, "dd/MM/yyyy HH:mm:ss".
444439

445440
gender.py is a filter which allows you to filter tweets based on a guess about
446441
the gender of the author. So for example you can filter out all the tweets that

‎docs/README_es_mx.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# twarc
22

3-
*Traducciones: [japonés], [Inglés], [Portugués], [Sueco], [Swahili]*
4-
53
twarc es una recurso de línea de commando y catálogo de Python para archivar JSON dato de Twitter. Cada tweet se representa como
64
un artículo de JSON que es [exactamente](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/tweet-object) lo que fue capturado del API de Twitter. Los Tweets se archivan como [JSON de línea orientado](https://en.wikipedia.org/wiki/JSON_streaming#Line-delimited_JSON). twarc se encarga del [límite de tarifa](https://developer.twitter.com/en/docs/basics/rate-limiting) del API de Twitter. twarc también puede facilitar la colección de usuarios, tendencias y detallar las identificaciones de los tweets.
75

‎docs/README_ja_jp.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
twarc
22
=====
33

4-
[![Build Status](https://secure.travis-ci.org/DocNow/twarc.png)](http://travis-ci.org/DocNow/twarc)
5-
6-
*翻訳: [英語], [ポルトガル語], [スペイン語], [スワヒリ語], [スウェーデン語]*
7-
84
twarcは、TwitterのJSONデータをアーカイブするためのコマンドラインツールおよびPythonライブラリーのプログラムです。
95

106
- 各ツイートは、Twitter APIから返された内容を[正確に](https://dev.twitter.com/overview/api/tweets)表すJSONオブジェクトとして表示されます。

‎docs/README_pt_br.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
twarc
22
=====
33

4-
[![Build Status](https://secure.travis-ci.org/DocNow/twarc.png)](http://travis-ci.org/DocNow/twarc)
5-
6-
*Traduções: [Espanhol], [Inglês], [Japonês], [Suaíli], [Sueco]*
7-
84
twarc é uma ferramenta de linha de comando e usa a biblioteca Python para arquivamento de dados do Twitter com JSON.
95
Cada tweet será representado como um objeto JSON
106
[exatamente](https://dev.twitter.com/overview/api/tweets) o que foi devolvido pela

‎docs/README_sv_se.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
twarc
22
=====
33

4-
[![Build Status](https://secure.travis-ci.org/DocNow/twarc.png)](http://travis-ci.org/DocNow/twarc)
5-
6-
*Översättningar: [Engelska], [Japanska], [Portugisiska], [Spanska], [Swahili]*
7-
84
twarc är ett kommandoradsverktyg twarc och ett Pythonbibliotek för arkivering av Twitter JSON data.
95
Varje tweet är representerat som ett JSON-objekt som är [exakt](https://dev.twitter.com/overview/api/tweets) vad som returneras från Twitters API
106
Tweets lagras som [line-oriented JSON](https://en.wikipedia.org/wiki/JSON_Streaming#Line-delimited_JSON). twarc hanterar

‎docs/README_sw_ke.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
twarc
22
=====
33

4-
[![Build Status](https://secure.travis-ci.org/DocNow/twarc.png)](http://travis-ci.org/DocNow/twarc)
5-
6-
*Tafsiri: [Kiingereza], [Kijapani], [Kihispania], [Kireno], [Kisweden]*
7-
84
twarc ni chombo ya command-line na Python Library ya kuhifadhi Twitter JSON
95
data. Kila Tweet ita akilishwa kama kitu ya JSON ita onyeshwa
106
[hivi](https://dev.twitter.com/overview/api/tweets) kutoka kwa Twitter API.

‎docs/README_zw_zh.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
twarc
22
=====
33

4-
[![Build Status](https://secure.travis-ci.org/DocNow/twarc.png)](http://travis-ci.org/DocNow/twarc)
5-
6-
*翻译: [英语], [日语], [葡萄牙语], [西班牙语], [斯瓦希里语], [瑞典语]*
7-
84
twarc 是一个用来处理并存档推特 JSON 数据的命令行工具和 Python 包。
95

106
[正如](https://dev.twitter.com/overview/api/tweets)推特 API 返回的一样，twarc 处理的每一条推文都用一个 JSON 对象来表示。twarc 会自动处理推特 API 的[流量限制](https://dev.twitter.com/rest/public/rate-limiting)。除了可以让你收集推文之外，twarc 还可以帮助你收集用户信息、当下流行的标签和根据 id 获得推文的详细信息。
@@ -443,8 +439,6 @@ utils/network.py --hashtags tweets.jsonl tweets.gexf
443439

444440
额外的，如果你想将网络转换成一个随时间线动态变化（节点会出现和消失）的动态网络，你可以在 Gephi 中打开生成的 `GEXF` 文件，跟随这个[教程](https://seinecle.github.io/gephi-tutorials/generated-html/converting-a-network-with-dates-into-dynamic.html)实现。注意在 `tweets.gexf` 文件里，仅有 `start_date` 一栏但是却没有 `end_date` 一栏，这会导致节点出现在屏幕上后便不再消失。对于 Gephi 中的 `Time interval creation options` 跳出窗口，`Start time column` 应该是 `start_date`, 而 `End time column` 则是空白的。`Parse dates` 应该勾选，同时选择最后一个日期格式选项：`dd/MM/yyyy HH:mm:ss`, 如下图所示。
445441

446-
![Image of Correctly Chosen Options in Gephi's Create Time Interval Popup](gephi_correct_options_for_time_interval_popup.png)
447-
448442
`gender.py` 是一个可以猜测推文作者性别的脚本。比如下面的例子展示了如何保留看上去像是女性发出的推文并生成一个词云。
449443

450444
```shell

docs/client.md renamed to docs/api/client.md

File renamed without changes.

docs/client2.md renamed to docs/api/client2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# twarc.Client
1+
# twarc.Client2
22

33
::: twarc.client2
44
handler: python

0 commit comments

Comments
 (0)