https://github.com/willtheorangeguy/Auto-Anouncements
A bot framework that automatically sends announcements (or any other file) to a specified email address on Saturday night or when the script is run.
https://github.com/willtheorangeguy/Auto-Anouncements
bot email hacktoberfest python server
Last synced: about 1 month ago
JSON representation
A bot framework that automatically sends announcements (or any other file) to a specified email address on Saturday night or when the script is run.
- Host: GitHub
- URL: https://github.com/willtheorangeguy/Auto-Anouncements
- Owner: Dog-Face-Development
- License: gpl-3.0
- Created: 2017-12-08T01:45:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-09-05T04:24:33.000Z (10 months ago)
- Last Synced: 2025-09-27T06:22:43.942Z (9 months ago)
- Topics: bot, email, hacktoberfest, python, server
- Language: HTML
- Homepage:
- Size: 515 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Auto Announcements
A bot framework that automatically sends announcements (or any other file) to a specified email address.
Key Features •
Download •
How To Use •
Support •
Contributing •
Changelog •
Credits & Contributors
## Key Features
* Automatically send file on a schedule or on dispatch.
* Prompt for send and receive email addresses.
* Email addresses can be hard coded.
* Customizable HTML email body.
* Cross Platform.
## Download
You can **[download](https://github.com/willtheorangeguy/Auto-Anouncements/releases/latest) the source code** to run the scripts from the command line on Windows, macOS and Linux. **This will require [Python](https://www.python.org/downloads/).**
You can **[download](https://github.com/willtheorangeguy/Auto-Anouncements/releases/latest) the latest executable version** of Auto Announcements for Windows. **This does not require Python.**
## How To Use
To run the application, you can use [Git and the Python Interpreter](https://github.com/willtheorangeguy/Auto-Anouncements/main/README.md#git), which allows you to clone and run the application, [`pip`](https://github.com/willtheorangeguy/Auto-Anouncements/main/README.md#pip) to create a command line application, or [Docker](https://github.com/willtheorangeguy/Auto-Anouncements/main/README.md#docker) to create a container of the application.
### Git
To clone and run this application, you'll need [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/willtheorangeguy/Auto-Anouncements
# Go into the repository
$ cd Auto-Announcements
# Run the CLI
$ python send.py
```
### `pip`
You can install the program from the [Python Package Index](https://pypi.org/project/Auto-Annoucements/) through `pip`.
```bash
# Install via pip
$ pip install auto-announcements
# Run the CLI
$ auto-announcements
```
### Docker
You can pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line:
```bash
# Pull image
$ docker pull ghcr.io/willtheorangeguy/auto-announcements:master
# Run container
$ docker run -i -t ghcr.io/willtheorangeguy/auto-announcements:master python send.py
```
## Support
Customization for Auto Announcements can be found in the [`CUSTOMIZATION`](https://github.com/willtheorangeguy/Auto-Anouncements/blob/master/docs/CUSTOMIZATION.md) doc. More documentation is available in the **[Documentation](https://github.com/willtheorangeguy/Auto-Anouncements/tree/master/docs)** and on the **[Wiki](https://github.com/willtheorangeguy/Auto-Anouncements/wiki)**. If more support is required, please open a **[GitHub Discussion](https://github.com/willtheorangeguy/Auto-Anouncements/discussions)** or join our **[Discord](https://discord.gg/XVBj6WGjap)**.
## Contributing
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/willtheorangeguy/Auto-Anouncements/compare).
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
## Changelog
See the [`CHANGELOG`](CHANGELOG.md) file for details.
## Credits
This software uses the following open source packages, projects, services or websites:
GitHub
Python Software Foundation
PyInstaller
Carbon
Web - Plans
Web - Donate
Web - Donate
Web
## Contributors
* [@willtheorangeguy](https://github.com/willtheorangeguy) - Sponsor on [PayPal](https://paypal.me/wvdg44?country.x=CA&locale.x=en_US)
## You may also like...
* [ProgramVer](https://github.com/willtheorangeguy/ProgramVer) - An open-source, Python GUI version window to show copyright info and licenses.
* [PyWorkout](https://github.com/willtheorangeguy/PyWorkout) - A minimal CLI to keep you inspired during your workout!
* [PyAvatar](https://github.com/willtheorangeguy/PyAvatar) - Easily display all of your creative avatars to keep them consistent across websites.
## License
This project is licensed under the [MIT License](https://mit-license.org/) - see the [`LICENSE`](LICENSE.md) file for details. See the [Privacy Policy](https://github.com/willtheorangeguy/Auto-Anouncements/blob/master/docs/legal/PRIVACY.md), [Terms and Conditions](https://github.com/willtheorangeguy/Auto-Anouncements/blob/master/docs/legal/TERMS.md), and [EULA](https://github.com/willtheorangeguy/Auto-Anouncements/blob/master/docs/legal/EULA.md) for legal information.