Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spirosikmd/yupi

A simple tool to create gmail events on a specific date 📅☀️
https://github.com/spirosikmd/yupi

calendar events google-calendar google-plus

Last synced: about 2 months ago
JSON representation

A simple tool to create gmail events on a specific date 📅☀️

Awesome Lists containing this project

README

        

# yupi

[![CircleCI](https://circleci.com/gh/spirosikmd/yupi.svg?style=svg)](https://circleci.com/gh/spirosikmd/yupi)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/spirosikmd/yupi)

A simple tool to create gmail events on a specific date!

> Follow google apis [quickstart](https://developers.google.com/google-apps/calendar/quickstart/nodejs#step_1_turn_on_the_api_name)
to create a project with calendar and google+ access, generate `client_secret.json` file with credentials,
and put it in the project root.

## Installation

Install the package globally with

```bash
yarn global add yupi
```

or

```bash
npm i -g yupi
```

## Usage

The first time, you will need to give google calendar access for the tool to create events.

Create a configuration object for event data in your package.json. For example:

```json
{
"yupi": {
"summary": "Yupi Event - {{name}}",
"description": "{{name}} created a yupi event!"
}
}
```

You can use template variables that will be interpolated. The available template variables are:

- `name`: the authenticated person's first name

### CLI

```bash
yupi "next wednesday"
```

### Node

```javascript
const yupi = require('yupi');
yupi('next wednesday');
```