Skip to content

Commit 6a130de

Browse files
author
Aaron Gonzales
authored
Merge pull request #6 from tw-ddis/simplify_endpoints
Simplify endpoints handling
2 parents bff8991 + 6fe5636 commit 6a130de

8 files changed

Lines changed: 468 additions & 551 deletions

File tree

‎README.rst‎

Lines changed: 95 additions & 103 deletions
Large diffs are not rendered by default.

‎examples/api_example.ipynb‎

Lines changed: 48 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,12 @@
2828
{
2929
"cell_type": "code",
3030
"execution_count": 1,
31-
"metadata": {
32-
"collapsed": true
33-
},
31+
"metadata": {},
3432
"outputs": [],
3533
"source": [
3634
"import os\n",
3735
"import json\n",
38-
"from twittersearch import ResultStream, gen_endpoint, gen_rule_payload"
36+
"from twittersearch import ResultStream, gen_rule_payload"
3937
]
4038
},
4139
{
@@ -49,37 +47,19 @@
4947
},
5048
{
5149
"cell_type": "code",
52-
"execution_count": 4,
50+
"execution_count": 22,
5351
"metadata": {},
54-
"outputs": [
55-
{
56-
"name": "stdout",
57-
"output_type": "stream",
58-
"text": [
59-
"https://gnip-api.twitter.com/search/fullarchive/accounts/<account_name>/ogformat.json\n"
60-
]
61-
}
62-
],
52+
"outputs": [],
6353
"source": [
6454
"# set your environment variables here for enterprise access if you need to\n",
6555
"# os.environ[\"TWITTER_SEARCH_ACCOUNT_NAME\"] = \"\"\n",
6656
"# os.environ[\"TWITTER_SEARCH_PW\"] = \"\"\n",
6757
"\n",
68-
"\n",
69-
"enterprise_search_endpoint = gen_endpoint(kind=\"enterprise\", \n",
70-
" search_api=\"fullarchive\",\n",
71-
" account_name=os.environ[\"TWITTER_SEARCH_ACCOUNT_NAME\"],\n",
72-
" label=\"ogformat.json\",\n",
73-
" count_endpoint=False)\n",
74-
"\n",
58+
"enterprise_endpoint = \"<ENTER YOUR ENDPOINT HERE>\"\n",
7559
"enterprise_search_args = {\"username\": \"agonzales@twitter.com\",\n",
7660
" \"password\": os.environ[\"TWITTER_SEARCH_PW\"],\n",
77-
" \"url\": enterprise_search_endpoint,\n",
78-
" }\n",
79-
"\n",
80-
"\n",
81-
"\n",
82-
"print(enterprise_search_endpoint.replace(os.environ[\"TWITTER_SEARCH_ACCOUNT_NAME\"], '<account_name>'))"
61+
" \"endpoint\": enterprise_endpoint\n",
62+
" }"
8363
]
8464
},
8565
{
@@ -93,7 +73,7 @@
9373
},
9474
{
9575
"cell_type": "code",
96-
"execution_count": 20,
76+
"execution_count": 23,
9777
"metadata": {},
9878
"outputs": [
9979
{
@@ -108,14 +88,10 @@
10888
"# set your environment variables here for premium access if you need to\n",
10989
"# os.environ[\"TWITTER_SEARCH_BEARER_TOKEN\"] = \"\"\n",
11090
"\n",
111-
"\n",
112-
"premium_search_endpoint = gen_endpoint(kind=\"premium\",\n",
113-
" search_api=\"30day\",\n",
114-
" label=\"dev\",\n",
115-
" count_endpoint=False)\n",
91+
"premium_search_endpoint = \"https://api.twitter.com/1.1/tweets/search/30day/dev.json\"\n",
11692
"\n",
11793
"premium_search_args = {\"bearer_token\": os.environ[\"TWITTER_SEARCH_BEARER_TOKEN\"],\n",
118-
" \"url\": premium_search_endpoint,\n",
94+
" \"endpoint\": premium_search_endpoint,\n",
11995
" }\n",
12096
"\n",
12197
"print(premium_search_endpoint)"
@@ -130,7 +106,7 @@
130106
},
131107
{
132108
"cell_type": "code",
133-
"execution_count": 8,
109+
"execution_count": 24,
134110
"metadata": {},
135111
"outputs": [
136112
{
@@ -178,7 +154,7 @@
178154
},
179155
{
180156
"cell_type": "code",
181-
"execution_count": 22,
157+
"execution_count": 5,
182158
"metadata": {
183159
"collapsed": true
184160
},
@@ -189,7 +165,7 @@
189165
},
190166
{
191167
"cell_type": "code",
192-
"execution_count": 23,
168+
"execution_count": 6,
193169
"metadata": {},
194170
"outputs": [
195171
{
@@ -206,7 +182,7 @@
206182
},
207183
{
208184
"cell_type": "code",
209-
"execution_count": 24,
185+
"execution_count": 7,
210186
"metadata": {},
211187
"outputs": [
212188
{
@@ -218,7 +194,7 @@
218194
" ('920383435209891841', '@robotprincessfi hi there Fiona', [])]"
219195
]
220196
},
221-
"execution_count": 24,
197+
"execution_count": 7,
222198
"metadata": {},
223199
"output_type": "execute_result"
224200
}
@@ -241,16 +217,18 @@
241217
},
242218
{
243219
"cell_type": "code",
244-
"execution_count": 27,
245-
"metadata": {},
220+
"execution_count": 25,
221+
"metadata": {
222+
"collapsed": true
223+
},
246224
"outputs": [],
247225
"source": [
248226
"rs = ResultStream(**premium_search_args, rule_payload=rule, max_results=500, max_pages=1, )"
249227
]
250228
},
251229
{
252230
"cell_type": "code",
253-
"execution_count": 28,
231+
"execution_count": 26,
254232
"metadata": {},
255233
"outputs": [
256234
{
@@ -260,7 +238,7 @@
260238
"ResultStream: \n",
261239
"\t{\n",
262240
" \"username\":null,\n",
263-
" \"url\":\"https:\\/\\/api.twitter.com\\/1.1\\/tweets\\/search\\/30day\\/dev.json\",\n",
241+
" \"endpoint\":\"https:\\/\\/api.twitter.com\\/1.1\\/tweets\\/search\\/30day\\/dev.json\",\n",
264242
" \"rule_payload\":{\n",
265243
" \"query\":\"@robotprincessfi\",\n",
266244
" \"maxResults\":100\n",
@@ -272,7 +250,7 @@
272250
}
273251
],
274252
"source": [
275-
"print(str(rs).replace(os.environ[\"TWITTER_SEARCH_ACCOUNT_NAME\"], '<account_name>'))"
253+
"print(rs)"
276254
]
277255
},
278256
{
@@ -284,7 +262,7 @@
284262
},
285263
{
286264
"cell_type": "code",
287-
"execution_count": 29,
265+
"execution_count": 10,
288266
"metadata": {},
289267
"outputs": [
290268
{
@@ -308,7 +286,7 @@
308286
},
309287
{
310288
"cell_type": "code",
311-
"execution_count": 30,
289+
"execution_count": 11,
312290
"metadata": {},
313291
"outputs": [
314292
{
@@ -320,7 +298,7 @@
320298
" ('920383435209891841', '@robotprincessfi hi there Fiona', [])]"
321299
]
322300
},
323-
"execution_count": 30,
301+
"execution_count": 11,
324302
"metadata": {},
325303
"output_type": "execute_result"
326304
}
@@ -338,25 +316,25 @@
338316
},
339317
{
340318
"cell_type": "code",
341-
"execution_count": 31,
319+
"execution_count": 27,
342320
"metadata": {},
343321
"outputs": [
344322
{
345323
"name": "stdout",
346324
"output_type": "stream",
347325
"text": [
348-
"{\"query\":\"from:jack\",\"maxResults\":100,\"toDate\":\"201710150000\",\"fromDate\":\"201709010000\"}\n"
326+
"{\"query\":\"from:jack\",\"maxResults\":100,\"toDate\":\"201710300000\",\"fromDate\":\"201709010000\"}\n"
349327
]
350328
}
351329
],
352330
"source": [
353-
"rule = gen_rule_payload(\"from:jack\", from_date=\"2017-09-01\", to_date=\"2017-10-15\", max_results=100)\n",
331+
"rule = gen_rule_payload(\"from:jack\", from_date=\"2017-09-01\", to_date=\"2017-10-30\", max_results=100)\n",
354332
"print(rule)"
355333
]
356334
},
357335
{
358336
"cell_type": "code",
359-
"execution_count": 32,
337+
"execution_count": 16,
360338
"metadata": {},
361339
"outputs": [
362340
{
@@ -373,43 +351,37 @@
373351
},
374352
{
375353
"cell_type": "code",
376-
"execution_count": 33,
354+
"execution_count": 17,
377355
"metadata": {},
378356
"outputs": [
379357
{
380358
"data": {
381359
"text/plain": [
382-
"[('2017-10-14 22:57:23',\n",
383-
" 'I love to see Palestinians dancing and having fun. Good &amp;positive stories deserve to go viral as well. Watch this: https://t.co/42vOrC40Fu',\n",
384-
" []),\n",
385-
" ('2017-10-14 22:55:25',\n",
386-
" \"But don't argue with people on twitter about whether policies and laws are racist. Argue with your City Council and your state reps and senators and Mayor and alderman. And if you don't like how that argument went\\nfire em.\",\n",
387-
" []),\n",
388-
" ('2017-10-14 21:30:26',\n",
389-
" 'I saw @solangeknowles perform at Chinati last weekend. It was the most beautiful thing I’ve ever seen. Can’t stop thinking about it. https://t.co/1wNLiNCaxb',\n",
390-
" []),\n",
391-
" ('2017-10-14 19:17:33', '1', []),\n",
392-
" ('2017-10-14 17:30:01',\n",
393-
" '@monteiro @JohnPaczkowski @cwarzel Never asked for credit Mike',\n",
394-
" []),\n",
395-
" ('2017-10-14 17:26:00',\n",
396-
" '@cwarzel @JohnPaczkowski Will keep everyone updated on the original thread',\n",
360+
"[('2017-10-27 18:22:07',\n",
361+
" 'More clarity on our private information policy and enforcement. Working to build as much direct context into the product too https://t.co/IrwBexPrBA\\nTo provide more clarity on our private information policy, we’ve added specific examples of what is/is not a violation and insight into what we need to remove this type of content from the service. https://t.co/NGx5hh2tTQ',\n",
397362
" []),\n",
398-
" ('2017-10-14 17:03:38',\n",
399-
" '@davewiner Listened to it all. Doesn’t mean we are going to implement everything! ;)',\n",
363+
" ('2017-10-27 18:17:37',\n",
364+
" 'Launching violent groups and hateful images/symbols policy on November 22nd https://t.co/NaWuBPxyO5\\nWe will now launch our policies on violent groups and hateful imagery and hate symbols on Nov 22. During the development process, we received valuable feedback that we’re implementing before these are published and enforced. See more on our policy development process here 👇 https://t.co/wx3EeH39BI',\n",
400365
" []),\n",
401-
" ('2017-10-14 17:00:56',\n",
402-
" '@davewiner @realDonaldTrump Also not true. It’s a moment in time',\n",
366+
" ('2017-10-27 01:25:39', '@WillStick @lizkelley Happy birthday Liz!', []),\n",
367+
" ('2017-10-26 14:24:05',\n",
368+
" 'Off-boarding advertising from all accounts owned by Russia Today (RT) and Sputnik.\\n\\nWe’re donating all projected earnings ($1.9mm) to support external research into the use of Twitter in elections, including use of malicious automation and misinformation. https://t.co/zIxfqqXCZr',\n",
403369
" []),\n",
404-
" ('2017-10-14 17:00:20',\n",
405-
" '@davewiner Come on. This isn’t true. We care. We have to build a business to fund the service',\n",
370+
" ('2017-10-26 13:50:40', '@TMFJMo @anthonynoto Thank you', []),\n",
371+
" ('2017-10-26 13:36:19', '@gasca @stratechery @Lefsetz letter', []),\n",
372+
" ('2017-10-26 13:35:57',\n",
373+
" '@gasca @stratechery Bridgewater’s Daily Observations',\n",
406374
" []),\n",
407-
" ('2017-10-14 16:59:21',\n",
408-
" '@yaelwrites @JohnPaczkowski @cwarzel @jilliancyork Never said that. We are considering. Need to prioritize.',\n",
375+
" ('2017-10-26 02:40:25',\n",
376+
" 'Yup!!!! ❤️❤️❤️❤️ #davechappelle https://t.co/ybSGNrQpYF',\n",
377+
" ['davechappelle']),\n",
378+
" ('2017-10-26 00:07:23', '@ndimichino Sometimes', []),\n",
379+
" ('2017-10-25 20:15:19',\n",
380+
" 'Setting up at @CampFlogGnaw https://t.co/nVq8QjkKsf',\n",
409381
" [])]"
410382
]
411383
},
412-
"execution_count": 33,
384+
"execution_count": 17,
413385
"metadata": {},
414386
"output_type": "execute_result"
415387
}

0 commit comments

Comments
 (0)