-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
--------- Co-authored-by: Danc2050 <[email protected]> Co-authored-by: Teal Dulcet <[email protected]>
- Loading branch information
1 parent
137302d
commit f4d56ed
Showing
12 changed files
with
1,644 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
*.swp | ||
*.swo | ||
__pycache__/ | ||
*.pyc |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
include *.rst *.in |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# sendpy | ||
-------- | ||
## Overview | ||
sendpy is a command line email and text notification program that makes use | ||
of external and local SMTP servers to send messages. | ||
|
||
However, sendpy is much more than that. sendpy is rich in features and use cases. | ||
For example, using this program, one may: | ||
|
||
* Attach files to a message | ||
* Send Unicode emojis in the Subject or Body of a message | ||
* Digitally sign a message with S/MIME or PGP encryption | ||
* Send a notification when a long running process (LRP) has finished execution | ||
* Delay the sending of an email until a specific time | ||
* And more! | ||
|
||
Help for sending an e-mail and understanding this program can be found using `sendpy --help`, `sendpy --examples`, `sendpy --smtp-servers`, and `sendpy --gateways`. | ||
|
||
## Quick Start in 4 Easy Steps | ||
|
||
To expedite the ability for users to send a message, here is a quick setup and example: | ||
|
||
1. Install using the install command listed in PyPi. Be sure to use pip3. | ||
|
||
2. Set the default configuration file to store repetitive commands (e.g., username, password) with the command `sendpy --config`. | ||
|
||
3. Enable lower security settings in your external email client, if necessary (ex. [Gmail](https://myaccount.google.com/lesssecureapps)). | ||
|
||
4. Send a basic message `sendpy --subject "Employment Opportunity" --to "[email protected]" --message "Hello,\n\n When is a good time to talk about an open position we have for you?"`. | ||
|
||
## Dependencies | ||
The following libraries are used in this program: | ||
* [OpenSSL](https://www.openssl.org/) | ||
* [GNU Privacy Guard](https://gnupg.org/) (GPG) | ||
|
||
OpenSSL and GPG, are installed on most Linux | ||
distributions by default and may easily be installed on Windows and macOS. | ||
However, so long as a user is not signing emails (the `--passphrase` and `--certificate` flags), | ||
one may use this program without any additional installations on Windows or | ||
macOS. | ||
|
||
## Donate | ||
[PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=NJ4PULABRVNCC) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#!/usr/bin/python3 | ||
|
||
from sendpy.__main__ import main | ||
|
||
if __name__ == "__main__": | ||
sys.exit(main()) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
__pycache__ | ||
cert.pem |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# empty |
Oops, something went wrong.