Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suhlig/plaintweet
Provides a plaintext representation of a tweet
https://github.com/suhlig/plaintweet
Last synced: 18 days ago
JSON representation
Provides a plaintext representation of a tweet
- Host: GitHub
- URL: https://github.com/suhlig/plaintweet
- Owner: suhlig
- Created: 2022-03-12T17:07:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-14T18:38:06.000Z (about 2 years ago)
- Last Synced: 2024-06-21T13:06:14.269Z (5 months ago)
- Language: Go
- Size: 142 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
# plaintweet
* Provides a plaintext representation of a tweet
* Idea taken from [nerab/plaintweet](https://github.com/nerab/plaintweet) and rewritten in Go.
# Configuration
Create a new project at [developer.twitter.com](https://developer.twitter.com/) and export the bearer token as `TWITTER_BEARER_TOKEN`:
```command
$ export TWITTER_BEARER_TOKEN="DEADBEEF..."
```
Please quote the value; it most likely contains characters that are not shell safe.
For legacy accounts, the environment variables `$TWITTER_CONSUMER_KEY` and `$TWITTER_CONSUMER_SECRET` can be used instead.
# Print
`plaintweet print` prints a plain-text representation of a single tweet. Provide a tweet's URL or its number as an argument.
# Serve
`plaintweet serve` serves a plain-text representation of a single tweet via HTTP. It will start an HTTP server listening on `$PORT` (defaults to `8080`) and provide the same functionality as `print` (see above).
# Run
* Grab the [latest release](https://github.com/suhlig/plaintweet/releases/latest), unpack it and run `plaintweet` for more information.
* There is also a Docker image, run it with:
```command
$ docker run --env TWITTER_CONSUMER_KEY --env TWITTER_CONSUMER_SECRET -it suhlig/plaintweet
```
# Bonus
This application is intended for use in my course "[Web Services](https://ws.uhlig.it/)" at [DHBW](https://www.ravensburg.dhbw.de/studienangebot/bachelor-studiengaenge/informatik). For this purpose, it has some endpoints that showcase Kubernetes' [liveness and readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/):
* `/liveness` will generally return `200`, unless the environment variable `MAX_UPTIME` was set to a value [`time.ParseDuration`](https://pkg.go.dev/time#ParseDuration) accepts and the given time since server start has elapsed. Other paths will still work, but `/liveness` will return `500` thereafter.
* `/readiness` will return `200` if the authentication with Twitter is successful, otherwise `500` will be returned.
# Development
Ginkgo has some issues with argument parsing; a workaround for `ginkgo watch` is to combine [`watchexec`](https://github.com/watchexec/watchexec) and `go test`:
```command
$ cd server
$ watchexec go test
```
# TODO
* Add metrics endpoint counting the number of requests