https://github.com/utkuufuk/habit-service
Habit service for entrello, built on Google Sheets
https://github.com/utkuufuk/habit-service
google-sheets-api habit-tracking trello
Last synced: 7 months ago
JSON representation
Habit service for entrello, built on Google Sheets
- Host: GitHub
- URL: https://github.com/utkuufuk/habit-service
- Owner: utkuufuk
- License: mit
- Created: 2021-02-21T10:24:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T17:36:49.000Z (about 1 year ago)
- Last Synced: 2025-01-29T07:48:40.565Z (9 months ago)
- Topics: google-sheets-api, habit-tracking, trello
- Language: Go
- Homepage:
- Size: 190 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# habit-service
[](https://github.com/utkuufuk/habit-service/actions/workflows/ci.yml)
[](https://coveralls.io/github/utkuufuk/habit-service)
Habit service for [entrello](https://github.com/utkuufuk/entrello), built on top of Google Sheets.
## Spreadsheet Format
You must have a dedicated sheet for the current month in your spreadsheet.
_Do not delete sheets for past months as they may be used by the progress report feature._
Sheet names must follow a certain convention. Some examples:
The sheet format must follow this specific convention:
- Dates go to the first column, starting from `A3`. (Leave `A1` and `A2` blank.)
- Habit names go to the first row, starting from `B1`.
- Scores go to the second row, starting from `B2`.
Here's an example:
_Conditional formatting of the colors can be adjusted from Google Sheets UI._
## Usage
Start the server:
```sh
go run ./cmd/server
```
#### `GET /entrello`
Fetch all habits that are not marked yet as done/skipped/failed.
[entrello](https://github.com/utkuufuk/entrello) will periodically call this endpoint and create a Trello card for each returned habit.
Alternatively, you can run following command to print the same result set on the console:
```sh
go run ./cmd/cli
```
#### `POST /entrello`
Mark a habit as done/skipped/failed.
[entrello](https://github.com/utkuufuk/entrello) will call this endpoint whenever a habit card is archived on your Trello board.
#### `POST /progress-report`
Generate and send a progress report as a Telegram message.
This endpoint will **not** be called by [entrello](https://github.com/utkuufuk/entrello). It's meant to be called by a separate scheduled job, or manually on demand. You don't have to put anything in the `POST` request body, but if you set the `SECRET` environment variable, you must also set the `X-API-Key` header accordingly.
Alternatively, you can run following command to generate and send a progress report:
```sh
go run ./cmd/cli progress-report
```
## Configuration
Put your environment variables in a file called `.env`, based on `.env.example`.
| Environment Variable | Description |
|-|-|
| `TIMEZONE_LOCATION` | Timezone, e.g. `"Europe/Istanbul"` |
| `GSHEETS_CLIENT_ID` | Google Sheets Client ID |
| `GSHEETS_CLIENT_SECRET` | Google Sheets Client Secret |
| `GSHEETS_ACCESS_TOKEN` | Google Sheets Access Token |
| `GSHEETS_REFRESH_TOKEN` | Google Sheets Refresh Token |
| `SPREADSHEET_ID` | Google Spreadsheet ID |
| `PORT` | HTTP port (server mode only) |
| `SECRET` | API secret (server mode only, optional) |
| `PROGRESS_REPORT_SKIP_LIST` | Comma-separated habit names to be excluded from progress reports |
| `TELEGRAM_TOKEN` | Telegram Bot API Token |
| `TELEGRAM_CHAT_ID` | Telegram Bot Chat ID |
## Running With Docker
A new [Docker image](https://github.com/utkuufuk?tab=packages&repo_name=habit-service) will be created upon each [release](https://github.com/utkuufuk/habit-service/releases).
1. Authenticate with the GitHub container registry (only once):
```sh
echo $GITHUB_ACCESS_TOKEN | docker login ghcr.io -u GITHUB_USERNAME --password-stdin
```
2. Pull the latest Docker image:
```sh
docker pull ghcr.io/utkuufuk/habit-service/image:latest
```
3. Start a container:
```sh
# server
docker run -d \
-p : \
--env-file \
--restart unless-stopped \
--name habit-service \
ghcr.io/utkuufuk/habit-service/image:latest
# CLI
docker run --rm \
--env-file \
ghcr.io/utkuufuk/habit-service/image:latest \
./cli
```