https://github.com/portableant/vambot
Actions powered bot
https://github.com/portableant/vambot
api-wrapper github-action museum rstats rstats-twitter
Last synced: 8 months ago
JSON representation
Actions powered bot
- Host: GitHub
- URL: https://github.com/portableant/vambot
- Owner: portableant
- License: gpl-3.0
- Created: 2021-04-15T21:28:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-14T20:18:24.000Z (over 2 years ago)
- Last Synced: 2025-01-10T15:41:35.384Z (9 months ago)
- Topics: api-wrapper, github-action, museum, rstats, rstats-twitter
- Language: R
- Homepage: https://twitter.com/vambot2
- Size: 48.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VAMBot
A simple Twitter bot that tweets details from the [V&A Museum API v2](https://www.vam.ac.uk/blog/digital/va-launches-new-developer-api) (released 15/4/2021), which is well [documented by their team](https://developers.vam.ac.uk/guide/v2/welcome.html).
This bot is an R script, powered via a Github action. Inspired a bit by Londonmapbot's code which showed me how to automate the R script via an action.
This script calls a random object from the collections with an image attached, constructs a tweet and sends it with the url for the record.
## How to run this
1. Create a Twitter account for your bot
2. Sign up for a developer access with [Twitter](https://developer.twitter.com/en/apply-for-access)
3. Fork this repo (or just copy the code into a new repo)
4. Obtain your API keys from Twitter and add them as [GitHub secrets](https://docs.github.com/en/actions/reference/encrypted-secrets)
5. Edit variables retrieved from the api in the `vambot-tweet.R` file
6. Edit the `.github/workflows/vambot.yml` file to adjust [the cron schedule](https://crontab.guru/#10_*_*_*_*) Every 10 mins past the hour at the moment.
7. GitHub Actions run or throw a tantrum (if your keys are wrong for instance.)
## License
GPL V3