Module: analyse¶
The analyse module reads all the fetch files and then performs the analysis. It figures out what posts rank how high and which are local versus remote. It writes out the analysis to a JSON file.
At the moment, the ranking methodology is not great. I don't know a better way, but I'm open to suggestions. There are basically 2 rules:
- I prioritise boosts. A boost is rarer, so the post with the most boosts is a little more rare than a post with a lot of favourites. For example, on a recent monsterdon, all 3 "most boosted" posts had 19 boosts. The post with the most favourites, however, had 76 favourites.
- The same post can't appear in more than one category. If a post has the most boosts and the most favourites, it can't win both.
The method¶
- Calculate the
top_nposts with the most boosts. - Take those posts out of consideration. Look at the remaining posts and find the
top_nposts with the most favourites. - Take those posts out of consideration. Look at the remaning posts and find the
top_nposts with the most replies.
Code Reference¶
Module for analyzing toots for a hashtag. Reads a JSON dump of toots presumably written by the fetch() function.
analyse(config)
¶
Does a bunch of analysis over the toots. Returns a dict with the results suitable for sending to post(). The whole process is described in more detail in the methodology documentation.
Config Parameters Used¶
| Option | Description |
|---|---|
mastoscore:hashtag |
Hashtag to analyze |
mastoscore:top_n |
How many top toots to report |
mastoscore:timezone |
What timezone to convert times to |
mastoscore:event_start |
Start time of the event |
post:tag_users |
Whether we tag users with an @ or not |
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
ConfigParser
|
A ConfigParser object from the config module |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dict that includes a few elements:
- |
Source code in mastoscore/analyse.py
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | |
get_toots_df(config)
¶
Opens the journal files from a hierarchical directory structure, parses the toots, and does a bunch of analysis over the toots. Returns a df with the results. This is its own method because the graph() modules call it, as does analyse().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
ConfigParser
|
A ConfigParser object from the config module |
required |
Config Parameters Used¶
mastoscore:journaldir: Base directory to read JSON files frommastoscore:journalfile: Template for files to readmastoscore:event_year: Year of the event (YYYY)mastoscore:event_month: Month of the event (MM)mastoscore:event_day: Day of the event (DD)
Returns:
Pandas DataFrame with all the toots pulled in and converted to normalised types.
Source code in mastoscore/analyse.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | |
toots2df(toots, api_base_url)
¶
Take in a list of toots from a tooter object, turn it into a pandas dataframe with a bunch of data normalized.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
toots
|
list[dict[str, Any]]
|
list. A list of toots in the same format as returned by the search_hashtag() API |
required |
api_base_url
|
str
|
string. Expected to include protocol, like |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
A Pandas DataFrame that contains all the toots normalised. Normalisation includes:
|
Synthetic columns added:¶
- server: The server part of
api_base_url:server.example.comif theapi_base_urlishttps://server.example.com - userid: The user's name in
person@server.example.comformat. Note it does not have the leading@because tagging people is optional. - local: Boolean that is True if the toot comes from the
api_base_urlserver. False otherwise. - source: The server part of the server who owns the toot. I might be talking to
server.example.com, but they've sent me a copy of a toot fromother.example.social.
Source code in mastoscore/analyse.py
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 | |