README.md

ORANGINO

An amazing Tangerino plugin for Slack to punch in and out from your CLI, while automatically letting your team know if you're available or not.

---

Orangino uses the Reqwest crate to interact with the Tangerino API, while binding with Python to benefit from the official Slack client to publish messages to the channel of your choice.

Installation

Package Managers

# Cargo
cargo install orangino
# Debian
curl -LJO https://github.com/marcelovicentegc/orangino/releases/download/0.1.1/orangino_0.1.1_amd64.deb
sudo dpkg -i ./orangino_0.1.1_amd64.deb

Configuration

You will need:

1. A Slack app installed on your workspace with the following features and permissions and its API token:
   • Incoming webhooks
   • Bot
     • chat:write
     • incoming-webhook
     • pins:read
     • pins:write
2. Python version 3.5 up installed.
3. Rust's nightly version installed.

Orangino has a configuration file that allows you to set your credentials. The file must be named .orangino.toml. Currently, Orangino looks for this file in your home directory (/home/marcelo on Linux, /Users/Marcelo on macOs, C:\Users\Marcelo on Windows)

How to use Orangino

To have Orangino punch your card, you just need to call it:

$ orangino

Demo

Punching in

Punching out

Development directions ▶️

You will need:

1. A Slack app installed on your workspace with the following features and permissions:
   • Incoming webhooks
   • Bot
     • chat:write
     • incoming-webhook
     • pins:read
     • pins:write
2. Python version 3.5 up installed.
3. Rust's nightly version installed.
4. A .orangino.toml file with your credentials, following the .orangino.example.toml model on your home path:

employer_code = "12345"
pin = "9876"
tangerino_basic_token = "Basic xeAxZyEwTOsPZKdlIA=="

slack_channel = "#random"
slack_api_token = "xoxp-22f3f6aa-1a75-452c-b023-5365db9409ae"
greetings_message = "Hello world!"
goodbye_message = "Goodbye world!"

5. To install the dependencies: pip install -r requirements.txt && cargo build

You are good to go now, make changes to the app and run it: cargo run