Module: analyse¶
In many ways, the analyse module just encapsulates all the analysis. You don't need to run it at all by itself. I find it more useful to run post with dry-run set to true and look at the results that way.
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.
Parameters¶
- config: A ConfigParser object from the config module
Config Parameters Used¶
Option | Description |
---|---|
analyse:botusername |
Exclude toots from this ID |
analyse:journaldir |
Directory to read JSON files from |
analyse:journalfile |
Template for files to read |
analyse:top_n |
How many top toots to report |
analyse:timezone |
What timezone to convert times to |
analyse:tag_users |
Whether we tag users with an @ or not |
Returns¶
Dict that includes a few elements:
- preamble
: A bit of information about the analysis. Hashtag and when it was generated.
- num_toots
: A few lines of text that describe the analysis: total number of toots, servers, participants, etc.
- most_toots
: A line about the person that posted the most toots.
- max_boosts
, max_faves
, and max_replies
: pandas DataFrames that contain the top_n
toots in each of these categories.
Source code in mastoscore/analyse.py
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 233 234 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 |
|
get_dates(config)
¶
Given a config, it does a bunch of timezone math and returns a list of two datetime objects, the earliest and latest dates we analyse. Right now there's a hard-coded 1-hour time that is subtracted from the start and added to the end. E.g., if you sent start_time = 12:00 and end_time = 14:00, this function currently returns 11:00 and 15:00 as the two times.
Parameters¶
- config: A ConfigParser object from the config module
Config Parameters Used¶
analyse:start_time
: start time for the eventanalyse:end_time
: end time for the eventanalyse:timezone
: the time zone to localise all the times toanalyse:hours_margin
: How many days to go back for analysis. You might have fetched toots from days ago, but then want to restrict analysis to toots from today.
Returns¶
List of two datetime
objects: the earliest possible time and latest possible time
Source code in mastoscore/analyse.py
19 20 21 22 23 24 25 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 |
|
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() module calls it.
Parameters¶
- config: A ConfigParser object from the config module
Config Parameters Used¶
analyse:botusername
: Exclude toots from this IDanalyse:journaldir
: Base directory to read JSON files fromanalyse:journalfile
: Template for files to readanalyse:top_n
: How many top toots to reportmastoscore: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
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 |
|