comparing 73aaf406077b37fad491f0efa6cdc319cf820c3a and main on ryan.freumh.org/caledonia

+7 -1

README.md

···

       1
       1
       -
       # 📅 Caledonia 🏴󠁧󠁢󠁳󠁣󠁴󠁿

     

       1
       1
       +
       # Caledonia

     

       2
       2
        
       

     

       3
       3
        
       Caledonia is a calendar client with command-line and Emacs front-ends.

     

       4
       4
        
       It operates on a [vdir](https://pimutils.org/specs/vdir/) directory of [`.ics`](https://datatracker.ietf.org/doc/html/rfc5545) files as managed by tools like [vdirsyncer](https://github.com/pimutils/vdirsyncer), which allows it to interact with CalDAV servers.

     
···

       36
       36
        
       

     

       37
       37
        
       ```

     

       38
       38
        
       $ opam install .

     

       39
       39
       +
       ```

     

       40
       40
       +
       

     

       41
       41
       +
       With [Nix](https://nixos.org/),

     

       42
       42
       +
       

     

       43
       43
       +
       ```

     

       44
       44
       +
       $ nix shell 'git+https://tangled.sh/@ryan.freumh.org/caledonia?ref=main'

     

       39
       45
        
       ```

     

       40
       46
        
       

     

       41
       47
        
       ## Configuration

+33 -41

TODO.org

···

       1
       1
       -
       - [x] list/search events

     

       2
       2
       -
       - [x] add/remove events

     

       3
       3
       -
       - [x] edit events

     

       4
       4
       -
       - [x] timezones

     

       5
       5
       -
       - [x] remove collection module

     

       6
       6
       -
         - ref [[https://github.com/ocaml-ppx/ppxlib/issues/481]] cc patrick

     

       7
       7
       -
       - [ ] add timezone to call date functions and make it required

     

       8
       8
       -
       - [ ] allow editing recurrence-ids

     

       9
       9
       -
       - [ ] don't load all calendars into memory to show only one event

     

       10
       10
       -
       - [ ] support specifying duration

     

       11
       11
       -
       - [ ] better add/edit event datetime parsing

     

       12
       12
       -
         - day of the week

     

       13
       13
       -
         - month names

     

       14
       14
       -
         - allow editting date or time without touching the other

     

       15
       15
       -
         - NB in emacs we use org-mode's datetime picker

     

       16
       16
       -
       - [x] diagnose events failing to parse [[https://github.com/robur-coop/icalendar/issues/14]]

     

       17
       17
       -
       - [x] [[https://github.com/robur-coop/icalendar/pull/13][handle RECURRENCE-ID]]

     

       18
       18
       -
       - [x] [[https://github.com/robur-coop/icalendar/issues/15][RRULE with local datetime]]

     

       19
       19
       -
       - [ ] CalDAV syncing

     

       20
       20
       -
         - Currently, you can use [[https://github.com/pimutils/vdirsyncer][vdirsyncer]]

     

       21
       21
       -
       - [ ] support querying times as well as dates

     

       22
       22
       -
       - [ ] custom date/time formatting

     

       23
       23
       -
       - [ ] support querying regex

     

       24
       24
       -
       - [ ] support VTIMEZONE

     

       25
       25
       -
       - [ ] support VALARMS

     

       26
       26
       -
       - [ ] support VOTODS

     

       27
       27
       -
       - [ ] support VCARDS

     

       28
       28
       -
       - [x] server mode

     

       29
       29
       -
         - [x] hold =Event='s in-memory instead of parsing them for every =Query=

     

       30
       30
       -
       - [ ] implement TUI front end with something like [[https://github.com/leostera/minttea][minttea]]

     

       31
       31
       -
       - [ ] implement an emacs front end, like mu4e to mu

     

       32
       32
       -
         - [x] listing, searching, querying

     

       33
       33
       -
         - [x] show details

     

       34
       34
       -
         - [x] show file

     

       35
       35
       -
         - [x] refresh

     

       36
       36
       -
         - [x] list possible calendars

     

       37
       37
       -
         - [x] add functions and bindings to change query parameters on the fly

     

       38
       38
       -
         - [ ] timezone support

     

       39
       39
       -
           - [ ] check the date module

     

       40
       40
       -
         - [ ] support adding, deleting, and editing events

     

       41
       41
       -
         - [ ] don't print end date if it's the same as the start date (will require a different sort function)

     

       1
       1
       +
       * DONE list/search events

     

       2
       2
       +
       * DONE add/remove events

     

       3
       3
       +
       * DONE edit events

     

       4
       4
       +
       * DONE timezones

     

       5
       5
       +
       * DONE diagnose events failing to parse [[https://github.com/robur-coop/icalendar/issues/14]]

     

       6
       6
       +
       * DONE [[https://github.com/robur-coop/icalendar/pull/13][handle RECURRENCE-ID]]

     

       7
       7
       +
       * DONE [[https://github.com/robur-coop/icalendar/issues/15][RRULE with local datetime]]

     

       8
       8
       +
       * DONE server mode

     

       9
       9
       +
       * DONE hold =Event='s in-memory instead of parsing them for every =Query=

     

       10
       10
       +
       * TODO support vdir metadata

     

       11
       11
       +
       * TODO add timezone all date functions

     

       12
       12
       +
       * TODO allow editing recurrence-ids

     

       13
       13
       +
       * TODO support specifying duration

     

       14
       14
       +
       * TODO CalDAV syncing

     

       15
       15
       +
       * TODO support complex datetime queries

     

       16
       16
       +
       * TODO custom date/time formatting

     

       17
       17
       +
       * TODO support querying text with regex

     

       18
       18
       +
       * TODO support VTIMEZONE

     

       19
       19
       +
       * TODO support VALARMS

     

       20
       20
       +
       * TODO support VOTODS

     

       21
       21
       +
       * TODO support VCARDS

     

       22
       22
       +
       * TODO support VJOURNAL

     

       23
       23
       +
       * TODO implement TUI front end with something like [[https://github.com/leostera/minttea][minttea]]

     

       24
       24
       +
       * TODO implement an emacs front end, like mu4e to mu

     

       25
       25
       +
       ** DONE listing, searching, querying

     

       26
       26
       +
       ** DONE show details

     

       27
       27
       +
       ** DONE show file

     

       28
       28
       +
       ** DONE refresh

     

       29
       29
       +
       ** DONE list possible calendars

     

       30
       30
       +
       ** DONE add functions and bindings to change query parameters on the fly

     

       31
       31
       +
       ** TODO timezone support

     

       32
       32
       +
       ** TODO support adding, deleting, and editing events

     

       33
       33
       +
       ** TODO add a org-agenda style view for caledonia-list

caledonia.opam

···

       26
       26
        
         "eio_main" {>= "0.12"}

     

       27
       27
        
         "timere" {>= "0.8.0"}

     

       28
       28
        
         "timedesc" {>= "0.8.0"}

     

       29
       29
       +
         "ppx_sexp_conv" {>= "0.15.1"}

     

       29
       30
        
         "alcotest" {>= "1.8.0" & with-test}

     

       30
       31
        
       ]

     

       31
       32
        
       pin-depends: [

+175

flake.lock

···

       1
       1
       +
       {

     

       2
       2
       +
         "nodes": {

     

       3
       3
       +
           "flake-compat": {

     

       4
       4
       +
             "flake": false,

     

       5
       5
       +
             "locked": {

     

       6
       6
       +
               "lastModified": 1696426674,

     

       7
       7
       +
               "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",

     

       8
       8
       +
               "owner": "edolstra",

     

       9
       9
       +
               "repo": "flake-compat",

     

       10
       10
       +
               "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",

     

       11
       11
       +
               "type": "github"

     

       12
       12
       +
             },

     

       13
       13
       +
             "original": {

     

       14
       14
       +
               "owner": "edolstra",

     

       15
       15
       +
               "repo": "flake-compat",

     

       16
       16
       +
               "type": "github"

     

       17
       17
       +
             }

     

       18
       18
       +
           },

     

       19
       19
       +
           "flake-utils": {

     

       20
       20
       +
             "inputs": {

     

       21
       21
       +
               "systems": "systems"

     

       22
       22
       +
             },

     

       23
       23
       +
             "locked": {

     

       24
       24
       +
               "lastModified": 1731533236,

     

       25
       25
       +
               "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",

     

       26
       26
       +
               "owner": "numtide",

     

       27
       27
       +
               "repo": "flake-utils",

     

       28
       28
       +
               "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",

     

       29
       29
       +
               "type": "github"

     

       30
       30
       +
             },

     

       31
       31
       +
             "original": {

     

       32
       32
       +
               "owner": "numtide",

     

       33
       33
       +
               "repo": "flake-utils",

     

       34
       34
       +
               "type": "github"

     

       35
       35
       +
             }

     

       36
       36
       +
           },

     

       37
       37
       +
           "mirage-opam-overlays": {

     

       38
       38
       +
             "flake": false,

     

       39
       39
       +
             "locked": {

     

       40
       40
       +
               "lastModified": 1710922379,

     

       41
       41
       +
               "narHash": "sha256-j4QREQDUf8oHOX7qg6wAOupgsNQoYlufxoPrgagD+pY=",

     

       42
       42
       +
               "owner": "dune-universe",

     

       43
       43
       +
               "repo": "mirage-opam-overlays",

     

       44
       44
       +
               "rev": "797cb363df3ff763c43c8fbec5cd44de2878757e",

     

       45
       45
       +
               "type": "github"

     

       46
       46
       +
             },

     

       47
       47
       +
             "original": {

     

       48
       48
       +
               "owner": "dune-universe",

     

       49
       49
       +
               "repo": "mirage-opam-overlays",

     

       50
       50
       +
               "type": "github"

     

       51
       51
       +
             }

     

       52
       52
       +
           },

     

       53
       53
       +
           "nixpkgs": {

     

       54
       54
       +
             "locked": {

     

       55
       55
       +
               "lastModified": 1743761221,

     

       56
       56
       +
               "narHash": "sha256-g79y3RpbyfOlwm3W4yuMXLmmNI7iDgIDqg10nq8pz5U=",

     

       57
       57
       +
               "owner": "nixos",

     

       58
       58
       +
               "repo": "nixpkgs",

     

       59
       59
       +
               "rev": "e1964791d66993a8aa5b9f19c1c6dd5827851355",

     

       60
       60
       +
               "type": "github"

     

       61
       61
       +
             },

     

       62
       62
       +
             "original": {

     

       63
       63
       +
               "owner": "nixos",

     

       64
       64
       +
               "repo": "nixpkgs",

     

       65
       65
       +
               "type": "github"

     

       66
       66
       +
             }

     

       67
       67
       +
           },

     

       68
       68
       +
           "opam-nix": {

     

       69
       69
       +
             "inputs": {

     

       70
       70
       +
               "flake-compat": "flake-compat",

     

       71
       71
       +
               "flake-utils": [

     

       72
       72
       +
                 "flake-utils"

     

       73
       73
       +
               ],

     

       74
       74
       +
               "mirage-opam-overlays": "mirage-opam-overlays",

     

       75
       75
       +
               "nixpkgs": [

     

       76
       76
       +
                 "nixpkgs"

     

       77
       77
       +
               ],

     

       78
       78
       +
               "opam-overlays": "opam-overlays",

     

       79
       79
       +
               "opam-repository": "opam-repository",

     

       80
       80
       +
               "opam2json": "opam2json"

     

       81
       81
       +
             },

     

       82
       82
       +
             "locked": {

     

       83
       83
       +
               "lastModified": 1744376747,

     

       84
       84
       +
               "narHash": "sha256-CKZLqLgZtMrUyZKlroISYp6Z4aoN1N9xeyk0dPNxGvc=",

     

       85
       85
       +
               "owner": "RyanGibb",

     

       86
       86
       +
               "repo": "opam-nix",

     

       87
       87
       +
               "rev": "787eeba962582ff0142f445a74f1edb667d7e941",

     

       88
       88
       +
               "type": "github"

     

       89
       89
       +
             },

     

       90
       90
       +
             "original": {

     

       91
       91
       +
               "owner": "RyanGibb",

     

       92
       92
       +
               "ref": "timere",

     

       93
       93
       +
               "repo": "opam-nix",

     

       94
       94
       +
               "type": "github"

     

       95
       95
       +
             }

     

       96
       96
       +
           },

     

       97
       97
       +
           "opam-overlays": {

     

       98
       98
       +
             "flake": false,

     

       99
       99
       +
             "locked": {

     

       100
       100
       +
               "lastModified": 1726822209,

     

       101
       101
       +
               "narHash": "sha256-bwM18ydNT9fYq91xfn4gmS21q322NYrKwfq0ldG9GYw=",

     

       102
       102
       +
               "owner": "dune-universe",

     

       103
       103
       +
               "repo": "opam-overlays",

     

       104
       104
       +
               "rev": "f2bec38beca4aea9e481f2fd3ee319c519124649",

     

       105
       105
       +
               "type": "github"

     

       106
       106
       +
             },

     

       107
       107
       +
             "original": {

     

       108
       108
       +
               "owner": "dune-universe",

     

       109
       109
       +
               "repo": "opam-overlays",

     

       110
       110
       +
               "type": "github"

     

       111
       111
       +
             }

     

       112
       112
       +
           },

     

       113
       113
       +
           "opam-repository": {

     

       114
       114
       +
             "flake": false,

     

       115
       115
       +
             "locked": {

     

       116
       116
       +
               "lastModified": 1740730647,

     

       117
       117
       +
               "narHash": "sha256-6veU2WjUGcWDAzLDjoAI1L6GWZd0KIUq19sHcbJS+u8=",

     

       118
       118
       +
               "owner": "ocaml",

     

       119
       119
       +
               "repo": "opam-repository",

     

       120
       120
       +
               "rev": "f1f75fef5fbf1e8bd1cc9544e50b89ba59f625e2",

     

       121
       121
       +
               "type": "github"

     

       122
       122
       +
             },

     

       123
       123
       +
             "original": {

     

       124
       124
       +
               "owner": "ocaml",

     

       125
       125
       +
               "repo": "opam-repository",

     

       126
       126
       +
               "type": "github"

     

       127
       127
       +
             }

     

       128
       128
       +
           },

     

       129
       129
       +
           "opam2json": {

     

       130
       130
       +
             "inputs": {

     

       131
       131
       +
               "nixpkgs": [

     

       132
       132
       +
                 "opam-nix",

     

       133
       133
       +
                 "nixpkgs"

     

       134
       134
       +
               ]

     

       135
       135
       +
             },

     

       136
       136
       +
             "locked": {

     

       137
       137
       +
               "lastModified": 1671540003,

     

       138
       138
       +
               "narHash": "sha256-5pXfbUfpVABtKbii6aaI2EdAZTjHJ2QntEf0QD2O5AM=",

     

       139
       139
       +
               "owner": "tweag",

     

       140
       140
       +
               "repo": "opam2json",

     

       141
       141
       +
               "rev": "819d291ea95e271b0e6027679de6abb4d4f7f680",

     

       142
       142
       +
               "type": "github"

     

       143
       143
       +
             },

     

       144
       144
       +
             "original": {

     

       145
       145
       +
               "owner": "tweag",

     

       146
       146
       +
               "repo": "opam2json",

     

       147
       147
       +
               "type": "github"

     

       148
       148
       +
             }

     

       149
       149
       +
           },

     

       150
       150
       +
           "root": {

     

       151
       151
       +
             "inputs": {

     

       152
       152
       +
               "flake-utils": "flake-utils",

     

       153
       153
       +
               "nixpkgs": "nixpkgs",

     

       154
       154
       +
               "opam-nix": "opam-nix"

     

       155
       155
       +
             }

     

       156
       156
       +
           },

     

       157
       157
       +
           "systems": {

     

       158
       158
       +
             "locked": {

     

       159
       159
       +
               "lastModified": 1681028828,

     

       160
       160
       +
               "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",

     

       161
       161
       +
               "owner": "nix-systems",

     

       162
       162
       +
               "repo": "default",

     

       163
       163
       +
               "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",

     

       164
       164
       +
               "type": "github"

     

       165
       165
       +
             },

     

       166
       166
       +
             "original": {

     

       167
       167
       +
               "owner": "nix-systems",

     

       168
       168
       +
               "repo": "default",

     

       169
       169
       +
               "type": "github"

     

       170
       170
       +
             }

     

       171
       171
       +
           }

     

       172
       172
       +
         },

     

       173
       173
       +
         "root": "root",

     

       174
       174
       +
         "version": 7

     

       175
       175
       +
       }

+39

flake.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         inputs = {

     

       3
       3
       +
           nixpkgs.url = "github:nixos/nixpkgs";

     

       4
       4
       +
           opam-nix.url = "github:tweag/opam-nix";

     

       5
       5
       +
           flake-utils.url = "github:numtide/flake-utils";

     

       6
       6
       +
           # we pin opam-nix's nixpkgs to follow the flakes, avoiding using two different instances

     

       7
       7
       +
           opam-nix.inputs.nixpkgs.follows = "nixpkgs";

     

       8
       8
       +
           # deduplicate flakes

     

       9
       9
       +
           opam-nix.inputs.flake-utils.follows = "flake-utils";

     

       10
       10
       +
         };

     

       11
       11
       +
         outputs = { self, nixpkgs, flake-utils, opam-nix, ... }@inputs:

     

       12
       12
       +
           flake-utils.lib.eachDefaultSystem (system:

     

       13
       13
       +
             let

     

       14
       14
       +
               package = "caledonia";

     

       15
       15
       +
               pkgs = nixpkgs.legacyPackages.${system};

     

       16
       16
       +
               opam-nix-lib = opam-nix.lib.${system};

     

       17
       17
       +
               devPackagesQuery = {

     

       18
       18
       +
                 ocaml-lsp-server = "*";

     

       19
       19
       +
                 ocamlformat = "*";

     

       20
       20
       +
                 utop = "*";

     

       21
       21
       +
               };

     

       22
       22
       +
               query = {

     

       23
       23
       +
                 ocaml-base-compiler = "*";

     

       24
       24
       +
               };

     

       25
       25
       +
               scope =

     

       26
       26
       +
                 opam-nix-lib.buildOpamProject' { } ./. (query // devPackagesQuery);

     

       27
       27
       +
             in {

     

       28
       28
       +
               packages.default = scope.${package};

     

       29
       29
       +
               defaultPackage = scope.${package};

     

       30
       30
       +
       

     

       31
       31
       +
               devShells.default = let

     

       32
       32
       +
                 devPackages = builtins.attrValues

     

       33
       33
       +
                   (pkgs.lib.getAttrs (builtins.attrNames devPackagesQuery) scope);

     

       34
       34
       +
               in pkgs.mkShell {

     

       35
       35
       +
                 inputsFrom = [ scope.${package} ];

     

       36
       36
       +
                 buildInputs = devPackages;

     

       37
       37
       +
               };

     

       38
       38
       +
             });

     

       39
       39
       +
       }

Compare changes