calendar-assistant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72759e81d1f7e1a67ae2efcc7cbf1f3698c8d62262e68e7fc53cad7362f5311f
+  data.tar.gz: 0e14e1c2793340d7ead49349e116fad4da8f67e9ca87e2c22d3ad88088d20cc6
+SHA512:
+  metadata.gz: 5e7ec4c110239ae51755851c694d421575ace9ab0c9c04ab3e79cde8729815bd65d87bedb4570f02ac751d91439db7dbce7b5af4800177ec30ab1c01d4f9b279
+  data.tar.gz: b9a362d7a750b767fb39d2d9f76dd0f758d0de23b8ddaf3d4b7e4759c71624febc699c25617ec5b058b788433754bf07bc6e0931511a9d9504fcd4957f06da8e

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,13 @@
+Copyright (c) 2018-Present Mike Dalessio, All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,410 @@
+
+# calendar assistant
+
+A command-line tool to help me manage my Google Calendar.
+
+- book (and re-book) one-on-ones and other meetings automatically
+- set up all-day events to let people know your location in the world
+- easily join the videoconference for your current meeting
+
+[![Concourse CI](https://ci.nokogiri.org/api/v1/teams/calendar-assistants/pipelines/calendar-assistant/jobs/rake-spec/badge)](https://ci.nokogiri.org/teams/calendar-assistants/pipelines/calendar-assistant)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3525792e1feeccfd8875/maintainability)](https://codeclimate.com/github/flavorjones/calendar-assistant/maintainability)
+
+## Usage
+
+Head to [the quickstart](https://developers.google.com/calendar/quickstart/ruby) to enable the Calendar API for your Google account and create a new "project". Save the project info in `credentials.json`.
+
+Then run `calendar-assistant authorize PROFILE_NAME` (see below for details).
+
+Once you're authorized, feel free to delete the `credentials.json` file. You can re-download that info again if you ever need it.
+
+
+## Features
+
+### Pretty Display
+
+Events are nicely formatted, with faint strikeouts for events you've declined, and some additional attributes listed when present (e.g., "needsAction", "self", "not-busy", "1:1" ...)
+
+
+### Date and Time Specification
+
+All dates and times are interpreted by [Chronic](https://github.com/mojombo/chronic) and so can be fuzzy terms like "tomorrow", "tuesday", "next thursday", and "two days from now" as well as specific dates and times.
+
+For a date range or a datetime range, split the start and end with `..` or `...` (with or without spaces) like:
+
+* "tomorrow ... three days from now"
+* "2018-09-24..2018-09-27".
+
+Also note that every command will adopt an intelligent default, which is generally "today" or "now".
+
+
+### Duration Specification
+
+Some duration-related preferences are interpreted by [ChronicDuration](https://github.com/henrypoydar/chronic_duration) and so can be terms like "10m", "30 minutes", "four hours", etc.
+
+
+### Preferences
+
+All tokens and preferences will be stored in `~/.calendar-assistant` which is in TOML format.
+
+
+## Commands
+
+<pre>
+<b>$</b> calendar-assistant help
+Commands:
+  calendar-assistant authorize PROFILE_NAME                       # create (or validate) a profile named NAME with calendar access
+  calendar-assistant availability [DATE | DATERANGE | TIMERANGE]  # Show your availability for a date or range of dates (default 'today')
+  calendar-assistant config                                       # Dump your configuration parameters (merge of defaults and overrides from /home/flavorjones/.calendar-assistant)
+  calendar-assistant help [COMMAND]                               # Describe available commands or one specific command
+  calendar-assistant join [TIME]                                  # Open the URL for a video call attached to your meeting at time TIME (default 'now')
+  calendar-assistant location [DATE | DATERANGE]                  # Show your location for a date or range of dates (default 'today')
+  calendar-assistant location-set LOCATION [DATE | DATERANGE]     # Set your location to LOCATION for a date or range of dates (default 'today')
+  calendar-assistant show [DATE | DATERANGE | TIMERANGE]          # Show your events for a date or range of dates (default 'today')
+
+Options:
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+
+</pre>
+
+
+### View your configuration parameters
+
+Calendar Assistant has intelligent defaults, which can be overridden in the TOML file `~/.calendar-assistant`, and further overridden via command-line parameters. Sometimes it's nice to be able to see what defaults Calendar Assistant is using:
+
+<pre>
+<b>$</b> calendar-assistant help config
+Usage:
+  calendar-assistant config
+
+Options:
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+Dump your configuration parameters (merge of defaults and overrides from /home/flavorjones/.calendar-assistant)
+
+</pre>
+
+The output is TOML, which is suitable for dumping into `~/.calendar-assistant` and editing.
+
+<pre>
+<b>$</b> calendar-assistant config
+
+[settings]
+end-of-day = "6pm"
+meeting-length = "30m"
+profile = "work"
+start-of-day = "9am"
+
+</pre>
+
+
+### Authorize access to your Google Calendar
+
+<pre>
+<b>$</b> calendar-assistant help authorize
+Usage:
+  calendar-assistant authorize PROFILE_NAME
+
+Options:
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+Description:
+  Create and authorize a named profile (e.g., "work", "home", "flastname@company.tld") to access your calendar.
+
+  When setting up a profile, you'll be asked to visit a URL to authenticate, grant authorization, and generate and persist an access token.
+
+  In order for this to work, you'll need to follow the instructions at this URL first:
+
+  > https://developers.google.com/calendar/quickstart/ruby
+
+  Namely, the prerequisites are: 
+   1. Turn on the Google API for your account 
+   2. Create a new Google API Project 
+   3. Download the configuration file for the Project, and name it as `credentials.json`
+
+</pre>
+
+This command will generate a URL which you should load in your browser while logged in as the Google account you wish to authorize. Generate a token, and paste the token back into `calendar-assistant`.
+
+Your access token will be stored in `~/.calendar-assistant` in the `[tokens]` section.
+
+
+### Display your calendar events
+
+<pre>
+<b>$</b> calendar-assistant help show
+Usage:
+  calendar-assistant show [DATE | DATERANGE | TIMERANGE]
+
+Options:
+  -c, [--commitments], [--no-commitments]  # only show events that you've accepted with another person
+  -h, -?, [--help], [--no-help]            
+  -p, [--profile=PROFILE]                  # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]          # how dare you suggest there are bugs
+
+Show your events for a date or range of dates (default 'today')
+
+</pre>
+
+For example: display all events scheduled for tomorrow:
+
+<pre>
+<b>$</b> calendar-assistant show --profile=work 2018-10-01
+<i>mdalessio@pivotal.io (all times in America/New_York)
+</i>
+2018-10-01               <b> | 🗺  NJ</b><i> (not-busy, self)</i>
+<strike>2018-10-01  03:30 - 05:00 | INTERNATIONAL COFFEE DAYYYYYYYY</strike>
+<strike>2018-10-01  07:30 - 08:30 | Lunch and  -GDPR</strike>
+<strike>2018-10-01  07:30 - 08:30 | Lunch & Learn</strike>
+2018-10-01  08:00 - 09:00<b> | Commuting/Email</b><i> (recurring, self)</i>
+2018-10-01  09:00 - 10:30<b> | None</b><i> (self)</i>
+2018-10-01  10:30 - 10:55<b> | Mike D / Stev 1:1</b><i> (1:1, recurring)</i>
+2018-10-01  11:00 - 11:30<b> | Dublin Office Status Meeting</b><i> (recurring)</i>
+2018-10-01  11:30 - 12:00<b> | Mike/Rupa 1:1</b><i> (1:1, recurring)</i>
+<strike>2018-10-01  11:50 - 12:00 | Reminder: CF Standup prep (recurring)</strike>
+2018-10-01  12:00 - 12:30<b> | Lunch</b><i> (self)</i>
+<strike>2018-10-01  12:15 - 12:30 | CF NYC Standup (recurring)</strike>
+<strike>2018-10-01  12:30 - 13:30 | Office Events Retro</strike>
+2018-10-01  12:30 - 13:30<b> | Global Director's Check-In</b><i> (recurring)</i>
+2018-10-01  13:30 - 14:50<b> | proactivity</b><i> (self)</i>
+<strike>2018-10-01  13:30 - 14:30 | Psychological Safety Workshop (Session 1)</strike>
+2018-10-01  15:00 - 15:30<b> | Matthew/Mike</b><i> (1:1)</i>
+2018-10-01  16:00 - 17:00<b> | Mike/Ryan T. 1:1</b><i> (1:1, recurring)</i>
+2018-10-01  16:45 - 17:00<b> | Manager Initiative check-in</b><i> (recurring)</i>
+2018-10-01  17:00 - 17:30<b> | CF Security Council Sync</b><i> (recurring)</i>
+2018-10-01  17:30 - 17:55<b> | Mike / Dieu 1:1</b><i> (1:1, recurring)</i>
+<strike>2018-10-01  18:00 - 20:30 | Steak!</strike>
+<strike>2018-10-01  18:30 - 19:00 | SF CF Directors / HR Bi-weekly (recurring)</strike>
+<strike>2018-10-01  19:00 - 19:30 | CF SF Manager Sit Down (recurring)</strike>
+
+
+</pre>
+
+Display _only_ the commitments I have to other people using the `-c` option:
+
+<pre>
+<b>$</b> calendar-assistant show -c 2018-10-01
+<i>mdalessio@pivotal.io (all times in America/New_York)
+</i>
+2018-10-01  10:30 - 10:55<b> | Mike D / Stev 1:1</b><i> (1:1, recurring)</i>
+2018-10-01  11:00 - 11:30<b> | Dublin Office Status Meeting</b><i> (recurring)</i>
+2018-10-01  11:30 - 12:00<b> | Mike/Rupa 1:1</b><i> (1:1, recurring)</i>
+2018-10-01  12:30 - 13:30<b> | Global Director's Check-In</b><i> (recurring)</i>
+2018-10-01  15:00 - 15:30<b> | Matthew/Mike</b><i> (1:1)</i>
+2018-10-01  16:00 - 17:00<b> | Mike/Ryan T. 1:1</b><i> (1:1, recurring)</i>
+2018-10-01  16:45 - 17:00<b> | Manager Initiative check-in</b><i> (recurring)</i>
+2018-10-01  17:00 - 17:30<b> | CF Security Council Sync</b><i> (recurring)</i>
+2018-10-01  17:30 - 17:55<b> | Mike / Dieu 1:1</b><i> (1:1, recurring)</i>
+
+
+</pre>
+
+
+### Join a video call attached to a meeting
+
+<pre>
+<b>$</b> calendar-assistant help join
+Usage:
+  calendar-assistant join [TIME]
+
+Options:
+          [--join], [--no-join]    # launch a browser to join the video call URL
+                                   # Default: true
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+Open the URL for a video call attached to your meeting at time TIME (default 'now')
+
+</pre>
+
+Some examples:
+
+<pre>
+<b>$</b> calendar-assistant join
+2018-09-28  11:30 - 12:00 | Status Meeting (recurring)
+https://pivotal.zoom.us/j/ABC90210
+# ... and opens the URL, which is associated with an event happening now
+
+<b>$</b> calendar-assistant join work --no-join 11:30
+2018-09-28  11:30 - 12:00 | Status Meeting (recurring)
+https://pivotal.zoom.us/j/ABC90210
+# ... and does not open the URL
+</pre>
+
+
+### Find your availability for meetings
+
+This is useful for emailing people your availability. It only considers `accepted` meetings when determining busy/free.
+
+<pre>
+<b>$</b> calendar-assistant help availability
+Usage:
+  calendar-assistant availability [DATE | DATERANGE | TIMERANGE]
+
+Options:
+  -l, [--meeting-length=LENGTH]    # [default 30m] find chunks of available time at least as long as LENGTH (which is a ChronicDuration string like '30m' or '2h')
+  -s, [--start-of-day=TIME]        # [default 9am] find chunks of available time after TIME (which is a Chronic string like '9am' or '14:30')
+  -e, [--end-of-day=TIME]          # [default 6pm] find chunks of available time before TIME (which is a Chronic string like '9am' or '14:30')
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+Show your availability for a date or range of dates (default 'today')
+
+</pre>
+
+
+For example: show me my available time over a chunk of time:
+
+<pre>
+<b>$</b> calendar-assistant avail 2018-10-02..2018-10-04
+<i>mdalessio@pivotal.io
+- all times in America/New_York
+- looking for blocks at least 30 mins long
+</i>
+<b>Availability on Tuesday, October 2:
+</b>
+ • 11:25am - 12:00pm
+ • 1:30pm - 3:00pm
+ • 3:30pm - 4:00pm
+
+<b>Availability on Wednesday, October 3:
+</b>
+ • 9:00am - 10:30am
+ • 11:00am - 1:30pm
+ • 1:55pm - 2:30pm
+ • 2:55pm - 3:30pm
+
+<b>Availability on Thursday, October 4:
+</b>
+ • 10:55am - 1:00pm
+
+
+</pre>
+
+
+You can also set start and end times for the search, which is useful when looking for overlap with another time zone:
+
+<pre>
+<b>$</b> calendar-assistant avail 2018-10-02..2018-10-04 -s 12pm -e 7pm
+<i>mdalessio@pivotal.io
+- all times in America/New_York
+- looking for blocks at least 30 mins long
+</i>
+<b>Availability on Tuesday, October 2:
+</b>
+ • 11:25am - 12:00pm
+ • 1:30pm - 3:00pm
+ • 3:30pm - 4:00pm
+ • 6:25pm - 7:00pm
+
+<b>Availability on Wednesday, October 3:
+</b>
+ • 11:00am - 1:30pm
+ • 1:55pm - 2:30pm
+ • 2:55pm - 3:30pm
+ • 6:00pm - 7:00pm
+
+<b>Availability on Thursday, October 4:
+</b>
+ • 10:55am - 1:00pm
+ • 6:00pm - 7:00pm
+
+
+</pre>
+
+
+### Tell people where you are at in the world
+
+Declare your location as an all-day non-busy event:
+
+<pre>
+<b>$</b> calendar-assistant help location-set
+Usage:
+  calendar-assistant location-set LOCATION [DATE | DATERANGE]
+
+Options:
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+Set your location to LOCATION for a date or range of dates (default 'today')
+
+</pre>
+
+**Note** that you can only be in one place at a time, so existing location events may be modified or deleted when new overlapping events are created.
+
+Some examples:
+
+<pre>
+# create an event titled `🗺 WFH` for today
+<b>$</b> calendar-assistant location set -p home WFH
+<b>Created:</b>
+2018-09-03                | <b>🗺  WFH</b> (not-busy, self)
+
+# create an event titled `🗺 OOO` for tomorrow
+<b>$</b> calendar-assistant location-set OOO tomorrow
+<b>Created:</b>
+2018-09-04                | <b>🗺  OOO</b> (not-busy, self)
+
+# create an event titled `🗺 Spring One` on the days of that conference
+<b>$</b> calendar-assistant location-set "Spring One" 2018-09-24...2018-09-27
+<b>Created:</b>
+2018-09-24 - 2018-09-27   | <b>🗺  Spring One</b> (not-busy, self)
+
+# create a vacation event for next week
+<b>$</b> calendar-assistant location-set "Vacation!" "next monday ... next week friday"
+<b>Created:</b>
+2018-09-10 - 2018-09-14   | <b>🗺  Vacation!</b> (not-busy, self)
+</pre>
+
+
+### Look up where you're going to be
+
+<pre>
+<b>$</b> calendar-assistant help location
+Usage:
+  calendar-assistant location [DATE | DATERANGE]
+
+Options:
+  -h, -?, [--help], [--no-help]    
+  -p, [--profile=PROFILE]          # the profile you'd like to use (if different from default)
+          [--debug], [--no-debug]  # how dare you suggest there are bugs
+
+Show your location for a date or range of dates (default 'today')
+
+</pre>
+
+For example:
+
+<pre>
+<b>$</b> calendar-assistant location "2018-09-24...2018-09-28"
+<i>mdalessio@pivotal.io (all times in America/New_York)
+</i>
+2018-09-24 - 2018-09-27  <b> | 🗺  Spring One @ DC</b><i> (not-busy, self)</i>
+2018-09-28               <b> | 🗺  NJ</b><i> (not-busy, self)</i>
+
+
+</pre>
+
+
+## References
+
+Google Calendar Concepts: https://developers.google.com/calendar/concepts/
+
+Google's API docs: https://www.rubydoc.info/github/google/google-api-ruby-client/Google/Apis/CalendarV3
+
+Recurrence: https://github.com/seejohnrun/ice_cube
+
+
+## License
+
+See files `LICENSE` and `NOTICE` in this repository.