━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                LACERTA
                 Lacerta parses WhatsApp exported logs

                                Andinus
                ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Table of Contents
─────────────────

Demo
Installation
Documentation
News


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 Website          <https://andinus.nand.sh/lacerta>
 Source           <https://git.tilde.institute/andinus/lacerta>
 GitHub (mirror)  <https://github.com/andinus/lacerta>
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Demo
════

  This is an example output on randomly generated data.

  ┌────
  │ andinus@ > lacerta exported
  │ (   ●  )
  │ Parsed 28000 logs in 5.00s
  │ [=== ]
  │ Generated data in 6.00s
  │
  │ *---------*----------*-------*---------*-------*------------*------*
  │ | Name    | Messages | Words | Deleted | Media | ActiveHour | Left |
  │ *---------*----------*-------*---------*-------*------------*------*
  │ | User #1 | 9600     | 20000 | 500     | 900   | 22         | 10   |
  │ | User #2 | 6000     | 18000 | 200     | 900   | 22         | 20   |
  │ | User #3 | 12000    | 40000 | 300     | 1000  | 22         | 0    |
  │ --------------------------------------------------------------------
  │ *---------*------------*
  │ | Name    | FucksGiven |
  │ *---------*------------*
  │ | User #1 | 1          |
  │ | User #2 | 1          |
  │ | User #3 | 10         |
  │ ------------------------
  │ *---------*---------------*---------------*---------------*
  │ | Name    | MostSpoken-#1 | #2            | #3            |
  │ *---------*---------------*---------------*---------------*
  │ | User #1 | word (90)     | then (20)     | have (20)     |
  │ | User #2 | word (100)    | then (300)    | have (30)     |
  │ | User #3 | word (1000)   | deleted (200) | deleted (200) |
  │ -----------------------------------------------------------
  └────


Installation
════════════

  Lacerta is released to `fez', you can get it from there or install it
  from source. In any case, `zef' is required to install the
  distribution.

  You can run Lacerta without `zef'. Just run `raku -Ilib bin/lacerta'
  from within the source directory.


Release
───────

  1. Run `zef install lacerta'.

  Lacerta should be installed, try running `lacerta --version' to
  confirm.


From Source
───────────

  You can either download the release archive generated by cgit/GitHub
  or clone the project if you have `git' installed.


Without `git'
╌╌╌╌╌╌╌╌╌╌╌╌╌

  1. Download the release:
     • <https://git.tilde.institute/andinus/lacerta>
     • <https://github.com/andinus/lacerta/releases>
  2. Extract the file.
  3. Run `zef install .' in source directory.


With `git'
╌╌╌╌╌╌╌╌╌╌

  All commits will be signed by my [PGP Key].

  ┌────
  │ # Clone the project.
  │ git clone https://git.tilde.institute/andinus/lacerta
  │ cd lacerta
  │
  │ # Install lacerta.
  │ zef install .
  └────


[PGP Key]
<https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc>


Documentation
═════════════

Implementation
──────────────

  It reads the log line by line and tries to match it with `WhatsApp'
  grammar.


Options
───────

input
╌╌╌╌╌

  Exported WhatsApp log.


profile-name
╌╌╌╌╌╌╌╌╌╌╌╌

  Your WhatsApp profile name. This is required to get stats for /Left/
  and /Deleted/ column.


no-of-spoken
╌╌╌╌╌╌╌╌╌╌╌╌

  This sets the number of Most Spoken columns to be printed for each
  user. The default is 3.


Caveats
───────

  /Words/ count can be less than the actual count. If the message
  contains new lines then they have them in the log too. We read the log
  line by line, so it'll miss parts of messages with newline in them.


News
════

v0.1.1 - 2021-08-14
───────────────────

  ⁃ Add option for number of Most Spoken columns.


v0.1.0 - 2021-07-29
───────────────────

  Initial Implementation.