Skip to content

Commit 9a3fb93

Browse files
slgobinathslgobinath
committed
Add Google calendar desklet
1 parent 6d7b687 commit 9a3fb93

15 files changed

+1943
-0
lines changed

‎README.md

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Google Calendar Desklet
2+
3+
View your upcoming calendar events on your Cinnamon Desktop. This desklet uses `gcalendar` to pull events from Google Calendar. You can configure every aspect of the desklet using the configure dialog.
4+
5+
## Requirements
6+
7+
- Cinnamon 3.4, 3.6, 3.8, 4.0, 4.2, 4.4, or 4.6
8+
- `gcalendar`
9+
10+
## Installation
11+
12+
1. Install `gcalendar`:
13+
14+
[gcalendar](https://github.com/slgobinath/gcalendar) is a Free and Open Source Software developed by the same developer to read Google Calendar events from the terminal.
15+
16+
**Linux Mint:**
17+
18+
```bash
19+
sudo add-apt-repository ppa:slgobinath/gcalendar
20+
sudo apt update
21+
sudo apt install gcalendar
22+
```
23+
24+
**Arch:**
25+
26+
```bash
27+
yay -S gcalendar
28+
```
29+
30+
OR
31+
32+
```bash
33+
packer -S gcalendar
34+
```
35+
36+
**Disclaimer:** [ppa:slgobinath/gcalendar](https://launchpad.net/~slgobinath/+archive/ubuntu/gcalendar) and [AUR gcalendar](https://aur.archlinux.org/packages/gcalendar) are my (the developer of this desklet) own repositories that are not monitored by the Linux Mint team, and user installs it at their own discretion.
37+
38+
I am providing the PPA and AUR to make the installation process simple. However, if you have any concerns with adding a PPA or installing from AUR, you can also install `gcalendar` from [PyPi](https://pypi.org/project/gcalendar/) or from the source code.
39+
40+
**Install From PyPi:**
41+
42+
```bash
43+
sudo apt install python3-pip python3-setuptools python3-dateutil python3-oauth2client python3-googleapi
44+
pip3 install gcalendar
45+
```
46+
47+
**Install From Source:**
48+
49+
```bash
50+
sudo apt install python3-pip python3-setuptools python3-dateutil python3-oauth2client python3-googleapi git
51+
git clone https://github.com/slgobinath/gcalendar.git
52+
cd gcalendar
53+
pip3 install -e .
54+
```
55+
56+
For more information, please visit the `gcalendar` [GitHub Repository](https://github.com/slgobinath/gcalendar).
57+
58+
2. Authorize `gcalendar` to read your calendar.
59+
60+
Just run `gcalendar` from the terminal. It will open Google Calendar OAuth page in your default browser.
61+
62+
```bash
63+
gcalendar
64+
```
65+
66+
For more details, see this YouTube video: [gcalendar Authorization](https://www.youtube.com/watch?v=mwU8AQmzIPE&feature). After authorizing gcalendar, you should see your calendar events printed in the terminal.
67+
68+
3. Download and add this desklet.
69+
70+
4. If there is a warning sign in the "Desklets" dialog, try to remove and add the desklet again. If it doesn't work, a system restart may help the desklet to detect `gcalendar`.
71+
72+
## Features
73+
74+
- Select events from multiple calendars of the same Google account
75+
- Custom date range
76+
- Customize update frequency
77+
- Manually update the agenda by clicking on the desklet
78+
- Customize the look and feel
79+
- Multiple account support (Using `gcalendar --account`)
80+
81+
## FAQ
82+
83+
1. **How to manually refresh the desklet?**
84+
85+
Just click on the desklet. It will retrieve fresh events from Google Calendar.
86+
87+
2. **What does "No events found..." mean?**
88+
89+
It means you do not have any events in the selected time interval. By default, the desklet retrieves events for the next `7` days. You can modify it by adjusting the "Number of days to include (days)" property in the configuration dialog.
90+
If that doesn't work, please ensure that you have some events in your Google Calendar by visiting the official [website](https://calendar.google.com/calendar).
91+
92+
3. **What does "Unable to retrieve events..." mean?**
93+
94+
It means the desklet could not retrieve any events and there is a possible error. Please report the bug with the output of `gcalendar` command at [gcalendar issues](https://github.com/slgobinath/gcalendar/issues).
95+
96+
4. **How to report bugs?**
97+
98+
Please open a GitHub issue at [linuxmint/cinnamon-spices-desklets](https://github.com/linuxmint/cinnamon-spices-desklets/issues) if the desklet doesn't work as expected. Any gcalendar specific bugs must be reported at [gcalendar issues](https://github.com/slgobinath/gcalendar/issues).
99+
100+
5. **Can I use my own client id and client secrets?**
101+
102+
You can use your own credentials but use them with `gcalendar --client-id xxx --client-secret yyy` to authorize before using them in the desklet.
103+
104+
6. **I love this desklet/gcalendar and want to appreciate it. How can I express it?**
105+
106+
It is a great pleasure to see someone likes your work. Though I am the [core developer](https://github.com/slgobinath), there are other contributors contributing to this desklet by fixing bugs and translating it into other languages. If you like the desklet, please show it to the world by login to the [CINNAMON spices](https://cinnamon-spices.linuxmint.com/) website and clicking the <kbd>Like it</kbd> button. I also appreciate it, if you can [buy me a coffee](https://paypal.me/slgobinath)!
107+
108+
## Privacy Policy
109+
110+
**None of your data is collected, stored, processed or shared with the developer or any third-parties.** For more information, please check the detailed [privacy policy](https://www.javahelps.com/p/gcalendar.html#privacy-policy).

‎deploy.sh

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/bash
2+
rm -rf ~/.local/share/cinnamon/desklets/[email protected]
3+
cp -r files/[email protected] ~/.local/share/cinnamon/desklets/

0 commit comments

Comments
 (0)