Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelcurrin/tweet-gh-actions-py
Post a tweet message using a button in GitHub Actions 🐦 🎬 🐍
https://github.com/michaelcurrin/tweet-gh-actions-py
github-actions python tweepy tweet twitter twitter-api
Last synced: 16 days ago
JSON representation
Post a tweet message using a button in GitHub Actions 🐦 🎬 🐍
- Host: GitHub
- URL: https://github.com/michaelcurrin/tweet-gh-actions-py
- Owner: MichaelCurrin
- License: mit
- Created: 2021-03-07T11:32:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-10T08:49:32.000Z (over 2 years ago)
- Last Synced: 2024-11-14T22:06:43.187Z (3 months ago)
- Topics: github-actions, python, tweepy, tweet, twitter, twitter-api
- Language: Python
- Homepage:
- Size: 582 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tweet with GitHub Actions 🐦 🎬 🐍
> Post a tweet message by pressing a button in GitHub Actions that runs a Python script
[](https://github.com/MichaelCurrin/tweet-gh-actions-py/releases/)
[](#license)
[](https://python.org)
[](https://pypi.org/project/tweepy)
[](https://github.com/features/actions)
## About
- This is a template project - get a copy of it and then customize it for your needs.
- This project can post a tweet to your Twitter account using a cloud runner on GitHub.
- It runs using [GitHub Actions](https://michaelcurrin.github.io/dev-resources/resources/ci-cd/github-actions/) and a manual trigger - [Workflow dispatch](https://michaelcurrin.github.io/dev-cheatsheets/cheatsheets/ci-cd/github-actions/triggers.html#workflow-dispatch). See [tweet.yml](/.github/workflows/tweet.yml) workflow file.
- The flow does **not** rely on any Actions which are specialized around Twitter. Rather this uses a generic Python action and your own logic, so it is more flexible (you can query the API want however you want) and does not depend on a specialist library which might get forgotten and not maintained by the owner one day.
- This comes with a short Python script - [tweet.py](/tweepy.py). This is app that is run in the workflow, but you can of course update it or replace it with a script for another library or programming language.
- Twitter API keys must be generated by the repo owner and stored securely in GitHub Actions' Secrets (to avoid abuse) and these get used privately on the server side of the workflow (so no one else on GitHub or looking at the log can see your credentials).
## Disclaimer
Tweeting using API requests and some code actually requires _registering_ a dev account and dev app on Twitter.
See my [Twitter policies](https://michaelcurrin.github.io/python-twitter-guide/#/policies) guide for more info.
## Use-cases
> How you could use this project
- Tweet your GitHub repo URL or website URL on a deploy (like a merge to master or a release is created).
- Generate a random tweet message from a file of possible messages and tweet it daily.
- Just for fun, enter a message directly in GitHub Actions (though you're limited on the input which only accepts a single line of input - unless you adapted the Python script to convert `"\n"` text into an actual line break).
- Copy the code to run somewhere else. Like on your web server, a Lambda, an automated task or a manual script. Just avoid running tweet logic on a frontend (like with JS) and you'd unsafely expose your credentials, while running server side is fine.
## Sample usage
> How to run the GitHub Actions workflow manually to create a tweet
_Note: Only administrators of this repo can run the workflow. But the Actions logs are public if you want to see the history of runs._
Click _Run workflow_ button on the right:
Enter your message:
Check the output in the log:
View the profile on Twitter and see the new tweet added:
In this case, I've used my Whoopie Goldberg parody account for tweeting gold-related quotes and the gold price.
## Start tweeting from your own repo
Only an admin user of ths repo can Tweet using it. But if you copy this repo to your own account and have Twitter API credentials at hand, you can start tweeting with GitHub too.
Get a copy of this project:
[](https://github.com/MichaelCurrin/tweet-gh-actions-py/generate "Create repo from template")
Next, customize the secrets on GitHub as per the [docs](/docs).
Then run the workflow on GitHub to post a tweet using text that you enter.
### Customize
You can customize this project with your own logic.
Such as to generate a random message, based on a text file of possible messages.
You could make the workflow run daily by setting up a [Schedule](https://michaelcurrin.github.io/dev-cheatsheets/cheatsheets/ci-cd/github-actions/triggers.html#trigger-on-a-schedule) trigger.
Or you could tweet whenever you deploy or create a GitHub release. Though, if you are adding tweeting logic to an existing project, then instead of using this project, you might want to use a tweet-related Action from the [GitHub Actions marketplace](https://github.com/marketplace). Which means you just need a few lines in a workflow and don't need a whole Python script.
## Documentation
[](/docs/ "Go to docs")
## License
Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).