Added layer for synchronizing google-calendars to emacs by mhkc · Pull Request #8372 · syl20bnr/spacemacs

mhkc · 2017-02-15T10:33:37Z

The layer handles synchronization through org-gcal. It also adds an additional
calendar view through calfw.

It can be run stand alone but integrates nicely with org-mode.

Solves feature request #7741

Screenshots

Monthly overview of calendar events and scheduled TODOs

Agenda view of what is scheduled for the day

nixmaniack

This is great. I have been using org-gcal and calfw and it's nice to see it coming in spacemacs.
Can you add screenshot of how it looks? It'll give this PR more visibility.

I will try it later and provide more feedback.

nixmaniack · 2017-02-15T11:06:53Z

+
+(defun google-calendar/init-f ()
+  "Initialize f"
+  (use-package f))


Spacemacs already has dependency on f. This shouldn't be needed.

I was not sure whenever f came with emacs or was provided in some package or layer. I am removing it.

nixmaniack · 2017-02-15T11:11:30Z

+  "Initialize alert"
+  (use-package alert
+    :init
+    (setq alert-default-style 'notifications)))


Is it required to set it? Since this is platform dependant it'd be better to let user select notification style(or we detect and set up a sane one).
Also there are other packages/layers(slace layer, mu4e-alert) which are setting alert-default-style and I think it's time to consolidate effort to setup alert properly.

You are correct, I just tested it and you are not required to set alert-default-style. I am removing it.

aaronjensen

This is looking great, nice work. It'll be nice to be able to remove my custom code for this.

aaronjensen · 2017-02-27T16:01:18Z

+        "ags" 'org-gcal-sync
+        "agf" 'org-gcal-fetch))
+    :config
+    (setq org-gcal-down-days 365)   ;; Set org-gcal to download events a year in advance


I probably wouldn't want this as the default. Maybe this can just be documented as something that can change.

What is the default without that ?

Yes, it should be kept default - 365 is too big!

I agree. Ill restore the default value and add it to the documentation

aaronjensen · 2017-02-27T16:02:15Z

+    :config
+    (setq org-gcal-down-days 365)   ;; Set org-gcal to download events a year in advance
+    (add-hook 'after-init-hook 'org-gcal-fetch)
+    (add-hook 'kill-emacs-hook 'org-gcal-sync)


I believe this is an asynchronous operation. Does this actually do anything if emacs is being killed immediately? I know it's a last ditch attempt to get calendar entries up, but it'd be surprising if it worked.

aaronjensen · 2017-02-27T16:05:48Z

+    (add-hook 'after-init-hook 'org-gcal-fetch)
+    (add-hook 'kill-emacs-hook 'org-gcal-sync)
+    (add-hook 'org-capture-after-finalize-hook 'google-calendar/sync-cal-after-capture)
+    (run-with-idle-timer 600 t 'google-calendar/org-gcal-update)))


With this, there's no way for the calendar to update while emacs is in use throughout the day. org-gcal-fetch is not super disruptive, so I configured my emacs to create a a much shorter idle timer every 10 minutes or so. That way it tries to sync every 10 minutes if emacs is idle for, say, 30 seconds. That way you probably won't have your typing interrupted, but it'd still update while you're using emacs normally. The code to do that is here: https://github.com/aaronjensen/spacemacs.d/blob/fc69c4a1e643ad276268a2409fc736b28ee2ae14/lisp/init-org.el#L71-L106 (probably can be cleaned up a bit, but you get the idea)

aaronjensen · 2017-02-27T16:08:06Z

+                                      "* %^{Description}\n%^{LOCATION}p\n%(cfw:org-capture-day)\n%?"))
+#+END_SRC
+
+** Configure alert


It was unclear to me what these alerts were for. It seems that they're status messages from the org-gcal sync/fetch, which is not what I would have expected (I would have expected that they were calendar remindrs). AFAICT the only way to get those is with org-agenda-to-appt. Maybe it'd be worth integrating that as well? See here

I previously removed the alert dependency since I came to the same discovery as you. This reference in the README is just remnants from that.

Good point with org-agenda-to-appt. I don't have time to work on integrate it at the moment so I dont think it should be part of this PR.

aaronjensen · 2017-02-27T16:10:02Z

@@ -0,0 +1,166 @@
+#+TITLE: Google calendar layer


Would it make sense to have this be the general calendar layer and have org-gcal support just be optional (if a var is set, for example)

Depends if there are reliable packages that provides synchronization with other popular calendar services. Non Google calendar users could just exclude org-gcal in their dotfile and only use calfw.

aaronjensen · 2017-02-27T16:15:07Z

+  "Initializes org-gcal and adds keybindings for it's exposed functions"
+  (use-package org-gcal
+    :init
+    (progn


There's a bug in org-gcal that can cause it to choke on events that are private (Say you share your work calendar with your personal account and your work calendar has something marked private).

This will work around it until it is fixed in org-gcal and may be worth including in this layer:

(push (lambda (event) (plist-get event :summary)) org-gcal-fetch-event-filters)

jabranham · 2017-03-22T17:50:13Z

+    "Sync calendar after a event was added with org-capture.
+The function can be run automatically with the 'org-capture-after-finalize-hook'."
+    (when-let ((cal-files (mapcar 'f-expand (mapcar 'cdr org-gcal-file-alist)))
+               (capture-target (f-expand (car (cdr (org-capture-get :target)))))


This creates an error if the file in the org-capture-template is a variable (for example, (file org-default-notes-file))

robbyoconnor

Fix the CI failure: https://travis-ci.org/syl20bnr/spacemacs/jobs/234724860

dotpyfe · 2017-06-13T21:58:36Z

@mkhc do you think you'd be able to complete this soon? id love to use it!

robbyoconnor · 2017-06-14T05:23:55Z

@Voleking -- step 1) use a topic branch; step 2) fix the issues that travis is reporting. With regard to the other issues....don't know

nixmaniack · 2017-06-14T06:26:10Z

@Voleking - Reporting at upstream might be a better idea.

benreyn · 2017-09-13T13:22:25Z

Just poking my head in here. Does anyone know what the status of this layer is?

benreyn · 2017-10-10T14:57:16Z

@mhkc, do you have this hosted somewhere that I can clone and use it as a private layer?

Edit: Nevermind, I found it.

The layer handles synchronization through org-gcal. It also adds an additional calendar view through calfw. It can be run stand alone but integrates nicely with org-mode.

maikol-solis · 2020-09-23T12:43:18Z

It would be awesome if this is pushed to the develop branch.

smile13241324 · 2021-03-14T09:26:02Z

This looks cool, however I have noticed that some of the packages are pretty old, can someone have a short test and confirm that the current google apis are still working with this layer?

If it does I would volunteer to see what needs to be done to get this integrated into develop somewhere.

bhw-foss · 2021-05-20T17:56:15Z

I have tested this layer on

Ubuntu 20.04
GNU Emacs 27.1 (build 1, x86_64-pc-linux-gnu, GTK+ Version 3.24.20, cairo version 1.16.0) of 2020-09-19
Org mode version 9.4.6 (9.4.6-elpaplus @ /home/hanshen/.emacs.d/elpa/27.1/develop/org-plus-contrib-20210519/)
Spacemacs v.0.300.0 Commit: 2515f14
Latest on MELPA

Everything works as expected so far. I had previously setup org-gcal
independently and as far as I'm concerned that's the hardest step.

Only minor change needed is inclusion of the calfw-org package as discussed here mhkc/google-calendar-layer#8

Original PR has archived his repo. I have a forked version here, ready to test:

https://github.com/HanshenWang/google-calendar-layer

Where I've gone through the issues and PRs of the original and added minor fixups
where needed. It should work OOTB with instructions under the README install.

As it currently stands, I do believe it needs more testing before it can be
safely merged.

Specifically how google-calendar/org-gcal-update is going to be called. Via
run-with-idle-timer modified as aaronjensen mentioned above or perhaps
org-agenda-mode-hook?

To be clear, on the whole I am very grateful for the work done already. I
plan continuing to use the layer. Org-gcal is a needed QOL if one decides to use
org agenda semi-seriously. I know of and use Orgzly (for Android), but having a calendar that
is open to collaboration helps with that famous weak point of org mode.

Calfw is a nicety, but useful enough that I am sticking with it. I do wonder how
much interest there is though, and is there enough overlap between freedom loving
Emacs ideologues and people like myself who have drank some of the google koolaid?

@maikol-solis Are you still using this layer? How does it work for you?

lebensterben · 2021-08-24T02:07:38Z

@HanshenWang
you can open a new PR and add OP as co-author

bhw-foss · 2021-08-24T20:51:27Z

@lebensterben It would be better for someone else to carry this PR across the
finish line. I am content right now with this as a private layer. I definitely
agree should you close this PR, it's been 5 years.

Cheers,

smile13241324 · 2021-08-25T20:27:42Z

Lets close this, we can have a new PR which is using a more up-to-date code base if this feature is still wished by enough people.

robbyoconnor · 2021-08-26T20:31:07Z

I could take this on at some point and bring it up to date

nixmaniack reviewed Feb 15, 2017

View reviewed changes

aaronjensen reviewed Feb 27, 2017

View reviewed changes

jabranham reviewed Mar 22, 2017

View reviewed changes

robbyoconnor suggested changes May 24, 2017

View reviewed changes

mhkc added 3 commits October 23, 2017 08:35

Added layer for synchronizing google-calendars to emacs

d1fa190

The layer handles synchronization through org-gcal. It also adds an additional calendar view through calfw. It can be run stand alone but integrates nicely with org-mode.

Removed redundant dependencies and clarified variable names

c3dd326

Added configurable window setup for calendar view

0e4a9c7

duianto added Help wanted New Layer labels Sep 28, 2020

smile13241324 added the Need test report We require a test before this can be merged, best by someone working in the related language label May 3, 2021

smile13241324 closed this Aug 25, 2021

Conversation

mhkc commented Feb 15, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nixmaniack left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaronjensen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robbyoconnor left a comment

Choose a reason for hiding this comment

Uh oh!

dotpyfe commented Jun 13, 2017

Uh oh!

robbyoconnor commented Jun 14, 2017

Uh oh!

nixmaniack commented Jun 14, 2017

Uh oh!

benreyn commented Sep 13, 2017

Uh oh!

benreyn commented Oct 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maikol-solis commented Sep 23, 2020

Uh oh!

smile13241324 commented Mar 14, 2021

Uh oh!

bhw-foss commented May 20, 2021

Uh oh!

lebensterben commented Aug 24, 2021

Uh oh!

bhw-foss commented Aug 24, 2021

Uh oh!

smile13241324 commented Aug 25, 2021

Uh oh!

robbyoconnor commented Aug 26, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

mhkc commented Feb 15, 2017 •

edited

Loading

benreyn commented Oct 10, 2017 •

edited

Loading