2021-01-01 18:27:10 +00:00
|
|
|
# HappySend
|
2021-01-01 01:40:27 +00:00
|
|
|
|
2021-01-01 18:27:10 +00:00
|
|
|
HappySend is a tool that makes it easy to send wishes to lots of people through short text messages.
|
2021-01-01 01:40:27 +00:00
|
|
|
|
|
|
|
|
It simply parses a CSV file and uses [KDE Connect](https://community.kde.org/KDEConnect) 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:
|
|
|
|
|
|
2021-01-01 18:27:10 +00:00
|
|
|
happy-send [options] [arguments]
|
2021-01-01 01:40:27 +00:00
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
|
2021-01-01 18:27:10 +00:00
|
|
|
-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]
|
2021-01-01 01:40:27 +00:00
|
|
|
--help Show this help.
|
|
|
|
|
|
|
|
|
|
|
2021-01-01 18:27:10 +00:00
|
|
|
|
2021-01-01 01:40:27 +00:00
|
|
|
### 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
|
|
|
|
|
|
2021-01-01 01:44:29 +00:00
|
|
|
1. Fork it ( http://github.com/glenux/happy-send/fork )
|
2021-01-01 01:40:27 +00:00
|
|
|
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](https://github.com/glenux) - author & maintainer:
|
|
|
|
|
* You? Fork the project and become a contributor!
|
|
|
|
|
|
|
|
|
|
Got questions? Need help? Tweet at [@glenux](https://twitter.com/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.
|
|
|
|
|
|
