README.md

   1 Jan Pona Mute
   2 =============
   3
   4 The name is Toki Pona and means "many friends".
   5
   6 This is a very simple command line client for Diaspora that helps me
   7 deal with my specific use-cases:
   8
   9 - I want to check Diaspora for new comment on my threads
  10 - I want to leave new comments on my threads
  11 - I want to delete comments I left by mistake
  12
  13 It's *very* limited but it's helping me get started using the
  14 [https://github.com/marekjm/diaspy diaspy] Python library.
  15
  16 Installation
  17 ------------
  18
  19 We need the [https://github.com/marekjm/diaspy diaspy] library.
  20
  21 ```text
  22 $ git clone https://github.com/marekjm/diaspy.git
  23 $ cd diaspy
  24 $ pip3 install .
  25 ```
  26
  27 This gives me version 0.6.0. when I use `pip3 install diaspy` I get
  28 version 0.3.0 which doesn't work.
  29
  30 Quickstart
  31 ==========
  32
  33 ```text
  34 $ python3 jan-pona-mute.py
  35 Welcome to Diaspora! Use the intro command for a quick introduction.
  36 Pager set: /usr/bin/fold
  37 > account kensanata@pluspora.com
  38 Username and pod set: kensanata@pluspora.com
  39 > password *secret*
  40 Password set
  41 > login
  42  1. 2019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
  43  2. 2019-08-13T17:59:23.000Z Joe Doe commented on your post Please help me wi...
  44  3. 2019-08-13T17:03:45.000Z Jane Doe has liked your post I've started writin...
  45  4. 2019-08-13T15:02:50.000Z June Doe commented on your post I don't like Mon...
  46  5. 2019-08-13T14:48:51.000Z John Doe liked your post Monday again! What am I...
  47 Enter a number to select the notification.
  48 > 1
  49 2019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
  50 Loading...
  51
  52 I've started writing a Diaspora client for the command line. It's called Jan Pona
  53 Mute which means as much as "many friends" in English. It's written in Python and
  54 doesn't do much.
  55 > comments
  56 There are no comments on the selected post.
  57 > comment This is me leaving a comment.
  58 Comment posted
  59 > comments
  60
  61  1. 2019-08-13T20:04:35.000Z Alex Schroeder
  62
  63 Alex Schroeder (e3bd7110b2ee013620f200505608f9fe): This is me leaving a comment.
  64 > quit
  65 Be safe!
  66 ```
  67
  68 Next Step
  69 ---------
  70
  71 Use the `save` command to save the login information (including the
  72 password!) to an init file.
  73
  74 The init files searched are:
  75
  76 1. `~/.config/jan-pona-mute/login`
  77 2. `~/.config/.jan-pona-mute`
  78 3. `~/.jan-pona-mute`
  79
  80 If one of them exists while starting up, that's the file that gets
  81 written. If none exists, the first one is going to be created by the
  82 `save` command.
  83
  84 Any further commands you put into the file are simple executed as if
  85 you were to type them every time you start the program.
  86
  87 Notes
  88 -----
  89
  90 One thing I care about is editing comments with my favourite editor
  91 and previewing them. This works really well if you have `mdcat` as it
  92 renders Markdown. Here's the workflow:
  93
  94 1. check notifications
  95 2. pick a post
  96 3. show latest comments
  97 4. compose a note
  98 5. preview note
  99 6. leave a comment with that note
 100
 101 This is what it looks like, assuming your editor is `ed`:
 102
 103 ```text
 104 > notifications
 105 ...
 106 > 1
 107 ...
 108 > comments
 109 ...
 110 > note nice
 111 /home/alex/.config/jan-pona-mute/notes/nice: No such file or directory
 112 a
 113 OK, I like this. Thanks!
 114 .
 115 w
 116 25
 117 q
 118  1. nice
 119 Use 'edit' to create a note.
 120 > preview 1
 121 OK, I like this. Thanks!
 122 > comment 1
 123 ```
 124
 125 Reference
 126 ---------
 127
 128 So much is still in flux. Please use the `help` command to learn more.