Skip to main content

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.

Project description

Auto Announcements
Auto Announcements

A bot framework that automatically sends announcements (or any other file) to a specified email address.

Docker Build State PyPI Build State Pylint State CodeQL State GitHub Version GitHub Issues GitHub Pull Requests Discord Server ID Downloads GitHub Languages

Key FeaturesDownloadHow To UseSupportContributingChangelogCredits & Contributors

screenshot

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 the source code to run the scripts from the command line on Windows, macOS and Linux. This will require Python.

You can download 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, which allows you to clone and run the application, pip to create a command line application, or Docker to create a container of the application.

Git

To clone and run this application, you'll need Git and Python installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:

# Clone this repository
$ git clone https://github.com/Dog-Face-Development/Auto-Anouncements

# Go into the repository
$ cd Auto-Annoucenments

# Run the CLI
$ python send.py

pip

You can install the program from the Python Package Index through pip.

# Install via pip
$ pip install auto-announcements

# Run the CLI
$ auto-announcements

Docker

You can pull the Docker image from GitHub Packages. From your command line:

# Pull image
$ docker pull ghcr.io/dog-face-development/auto-anouncements:master

# Run container
$ docker run -i -t ghcr.io/dog-face-development/auto-anouncements:master python send.py

Support

Customization for Auto Announcements can be found in the CUSTOMIZATION doc. More documentation is available in the Documentation and on the Wiki. If more support is required, please open a GitHub Discussion or join our Discord.

Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us (including how to sign our CLA).

Changelog

See the CHANGELOG file for details.

Credits

This software uses the following open source packages, projects, services or websites:

GitHub PSF PyInstaller Carbon
GitHub Python Software Foundation PyInstaller Carbon
Web - Plans Web - Donate Web - Donate Web

Contributors

You may also like...

  • ProgramVer - An open-source, Python GUI version window to show copyright info and licenses.
  • PyWorkout - A minimal CLI to keep you inspired during your workout!
  • PyAvatar - Easily display all of your creative avatars to keep them consistent across websites.

License

This project is licensed under the GNU General Public License - see the LICENSE file for details. See the Privacy Policy, Terms and Conditions, and EULA for legal information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Auto-Announcements-0.2.0.tar.gz (42.0 kB view hashes)

Uploaded Source

Built Distribution

Auto_Announcements-0.2.0-py3-none-any.whl (28.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page