🟢 🔁 Stable | HappySend is a tool that makes it easy to send wishes to lots of people through short text messages.
Go to file
Glenn Y. Rolland 6d2ebe68d5 doc: add preamble about mirroring 2024-01-03 19:21:44 +01:00
.github/workflows Fix CI workflow name 2021-01-01 20:28:45 +01:00
config Initial import 2021-01-01 02:40:27 +01:00
src Re-organize code for readability 2021-01-01 19:26:55 +01:00
.gitignore Initial import 2021-01-01 02:40:27 +01:00
LICENSE.txt Initial import 2021-01-01 02:40:27 +01:00
Makefile Create build dir if missing 2021-01-01 20:15:29 +01:00
README.md doc: add preamble about mirroring 2024-01-03 19:21:44 +01:00
shard.lock Initial import 2021-01-01 02:40:27 +01:00
shard.yml Initial import 2021-01-01 02:40:27 +01:00

README.md

Build GitHub license Donate on patreon

This project is available on our self-hosted server and on CodeBerg and GitHub as mirrors. For the latest updates and comprehensive version of our project, please visit our primary repository at: https://code.apps.glenux.net/glenux/happy-send.

HappySend

HappySend is a tool that makes it easy to send wishes to lots of people through short text messages.

It simply parses a CSV file and uses KDE Connect command line tool to control your smartphone.

Installation

  1. Make sure that a recent version of Crystal (0.35) is installed
  2. Make sure that kdeconnect-cli is installed

Then run the following commands :

$ shards install
$ make build

That should create the binary _build/happy-send

Usage

Available options

Happy Send - Mass send short text messages via your smartphone + kdeconnect

Usage:

  happy-send [options] [arguments]

Options:

  -s, --send                       Send message for real (=not dry-run) [type:Bool] [default:false]
  -w, --wait=SECONDS               Wait SECONDS between each message (default: 5) [type:Int32] [default:5]
  -v, --verbose                    Enable debug messages [type:Bool] [default:false]
  -c FILE, --csv=FILE              Use given CSV (mandatory fields: number,message) [type:String] [required]
  --help                           Show this help.

Preparing your file

Fill a CSV file respecting the structure below. Note you can insert variables from other columns within your message.

"group","firstname","lastname","number","message"
"MAINTAINER","Glenn","Rolland","+33673983956","Happy new year {{ firstname }} !"
"HEROES","Jon","Snow","+33xxxxxx","Happy new year {{ firstname }} ! Winter is coming."
"HEROES","Harry","Potter","+32xxxxxx","Happy new year {{ firstname }} ! Expecto patronum in 2021 !"
"HEROES","Luke","Skywalker","+33xxxxxx","Happy new year {{ firstname }} ! May the force be with you in 2021"

Verify what will be done with the following command. No message will be sent yet :

$ _build/happy-send --csv config/friends.csv

Sending the messages !

Make sure your that

  1. Your smartphone has the KDE Connect app installed.
  2. Your smartphone is connected on the same wifi network as your computer

Verify that your computer is able to detect your smartphone

$ kdeconnect-cli -a
- Galaxy S8: b4fade0a33cdf703 (paired and reachable)
1 device found

If it is ok for you, launch it for real :

$ _build/happy-send --send --csv config/friends.csv

Contributing

  1. Fork it ( http://github.com/glenux/happy-send/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Credits

  • Glenn Y. ROLLAND - author & maintainer:
  • You? Fork the project and become a contributor!

Got questions? Need help? Tweet at @glenux

License

Happy Send is Copyright © 2018-2019 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file.