Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oradwell/verbose-twit-banner
Replace your Twitter profile banner with a verbose image
https://github.com/oradwell/verbose-twit-banner
golang twitter twitter-api
Last synced: about 9 hours ago
JSON representation
Replace your Twitter profile banner with a verbose image
- Host: GitHub
- URL: https://github.com/oradwell/verbose-twit-banner
- Owner: oradwell
- License: mit
- Created: 2021-09-29T19:53:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-01T01:57:28.000Z (over 1 year ago)
- Last Synced: 2025-01-11T02:55:06.023Z (8 days ago)
- Topics: golang, twitter, twitter-api
- Language: Go
- Homepage:
- Size: 2.4 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# verbose-twit-banner
[](https://github.com/oradwell/verbose-twit-banner/actions/workflows/ci-build.yml)
[](https://github.com/oradwell/verbose-twit-banner/actions/workflows/codeql-analysis.yml)
Replace your Twitter profile banner with an image
that contains your profile statistics
# Usage
## Run from Source
**Note:** Environment variables should be in `.env` file.
```bash
make run
```
## Build and Run with Docker
**Note:** Environment variables should be in `.env` file.
```bash
docker build . -t verbose-twit-banner
docker run --env-file=.env verbose-twit-banner
```
## Build a Binary
```bash
make build
```
Executable will be created as verbose-twit-banner.
## Ways of Operation
### Run in an Interval
Parameter `-interval=` can be used
to make the program run in a loop.
The banner image will be updated
in the specified time interval (e.g. 5m).
Valid time units are "ns", "us" (or "µs"),
"ms", "s", "m", "h".
### Read-only mode
Parameter `-dry-run` can be used
to make the program output an image.
Could be useful if you want to see
what image it would output
without replacing your banner image
Another advantage of this method is that you don't need
Twitter Access Key & Secret
so you can run it on anyone's Twitter account.
## Twitter API Access
You'll need to create a Project on Twitter to get access to the API
Details: https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api
### Obtaining App Consumer Key & Secret
Consumer Key & Secret are for accessing public Twitter profile statistics.
These are used in OAuth 2.0 authentication with Twitter.
API calls made using this set of credentials:
- [GET /2/users/by/username/:username](https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username)
- [GET /2/users/:id](https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id)
### Obtaining Access Token & Secret
Access Token & Secret are for uploading the generated banner to your Twitter profile.
These are used in OAuth 1.1 authentication with Twitter.
API call made using this set of credentials:
- [POST account/update_profile_banner](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner)
## Configuration
The binary has a few parameters.
Some of them also have equivalent environment variables.
### Command Line Parameters
Use `-h` to find out about the available parameters:
```bash
./verbose-twit-banner -h
```
### Environment Variables
File named [.env.dist](.env.dist) contains
all the available environment variables.
Instead of setting these environment variables
you can also copy the `.env.dist` file into `.env`.
# Tests
```bash
make test
```
# More info
[Program showcase](https://blog.radwell.codes/2022/01/go-program-for-a-unique-twitter-profile-banner/)