https://github.com/4rivappa/typeracer-readme
github action workflow for generating typeracer graph for readme
https://github.com/4rivappa/typeracer-readme
profile-readme python readme-generator readme-stats typeracer typeracer-stats
Last synced: 7 months ago
JSON representation
github action workflow for generating typeracer graph for readme
- Host: GitHub
- URL: https://github.com/4rivappa/typeracer-readme
- Owner: 4rivappa
- Created: 2023-05-22T07:13:01.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T00:45:09.000Z (over 1 year ago)
- Last Synced: 2024-04-13T20:49:12.482Z (over 1 year ago)
- Topics: profile-readme, python, readme-generator, readme-stats, typeracer, typeracer-stats
- Language: Python
- Homepage:
- Size: 298 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```
__ __ __
/ /___ ______ ___ _________ _________ _____ ____/ /___ _/ /_____ _
/ __/ / / / __ \/ _ \/ ___/ __ `/ ___/ _ \/ ___/ / __ / __ `/ __/ __ `/
/ /_/ /_/ / /_/ / __/ / / /_/ / /__/ __/ / / /_/ / /_/ / /_/ /_/ /
\__/\__, / .___/\___/_/ \__,_/\___/\___/_/ \__,_/\__,_/\__/\__,_/
/____/_/
```
typeracer-readme generates typeracer graph for profile readme
# how it works
getting data from typeracer with your username
1000 at a time, looping until it gets all racing data
generate two theme graphs (light and dark) images, and data.json file
# setup workflow
copy script.py and requirements.txt into root directory of your repo
copy typeracer_graph.yml yaml file into .github/workflows directory
# configure script.py
username variable
start_date variable (YYYY-MM-DD)
average-window
# adding graph to readme
add image with `src = "https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_REPOSITORY/typeracer-readme/dark_graph.png"`
typeracer-readme above determines the branch in which images are saved