Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pxseu/anilist-readme
Puts your newest activity from AniList into your readme!
https://github.com/pxseu/anilist-readme
anilist anilist-api anime github-actions
Last synced: 4 days ago
JSON representation
Puts your newest activity from AniList into your readme!
- Host: GitHub
- URL: https://github.com/pxseu/anilist-readme
- Owner: pxseu
- License: mpl-2.0
- Created: 2021-07-18T15:27:06.000Z (over 3 years ago)
- Default Branch: senpai
- Last Pushed: 2024-02-17T18:14:38.000Z (10 months ago)
- Last Synced: 2024-12-07T09:22:21.143Z (16 days ago)
- Topics: anilist, anilist-api, anime, github-actions
- Language: Python
- Homepage: https://github.com/marketplace/actions/anilist-readme-workflow
- Size: 56.6 KB
- Stars: 17
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AniList readme workflow
> Simple workflow that will add your latest activity into your readme!
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
## Note
This was made by a person who primarily uses TypeScript and doesn't know how to use Python.
## How to
Simply add this to your README.md
```html
# 🌸 My recent AniList activity
```
and setup the workflow file at `.github/workflows/anilist.yml` like this:
```yml
name: AniList readme workflow
on:
schedule:
# Runs every hour
- cron: "0 * * * *"
workflow_dispatch: # for manual debuging
jobs:
update-readme-with-anilist:
name: Update this repo's README with latest AniList activites
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: AniList readme workflow
uses: pxseu/anilist-readme@senpai # latest version
with:
user_id: YOUR_USER_ID # or
user_name: YOUR_USER_NAME
```
## Settings
| Option | Description | Default | Required |
| -------------------- | ---------------------------------------------------------------- | -------------------------------------- | -------- |
| `user_id` | Your AniList user id | "" | `True` |
| `user_name` | Your AniList username | "" | `True` |
| `max_post_count` | A number from 1 to 50 limiting the ammount of posts | "5" | `False` |
| `preferred_language` | The language of the list content (e.g. Romaji, English, Native) | "english" | `False` |
| `timezone` | Timezone of the list content (e.g. Europe/Berlin) | "UTC" | `False` |
| `date_format` | Date format of the list content (e.g. {D}/{M or MW}/{Y} {h}:{m}) | "{h}:{m} {D} {MW} {Y}" | `False` |
| `readme_path` | Path to the readme file to edit | "./README.md" | `False` |
| `gh_token` | Authorized github token | ${{ github.token }} | `False` |
| `commit_message` | A message to use when commiting | "Update AniList activity in README.md" | `False` |
| `commit_username` | The username for the commiter | "GitHub Action" | `False` |
| `commit_email` | The email for the commiter | "[email protected]" | `False` |
> Note: Eiter `user_id` or `user_name` is required! \
> I recommend you leave the default `commit_username` and `commit_email` \
> For `date_format` months: {M} will result in a number (e.g '3') & {MW} will result in a string (e.g 'March') \
> If you're unsure what's your User ID on AniList follow the quide below
## How to get my user ID
If you change your username frequently or you're unsure what your user id is, you can use the AniList API to get it.
Head on over to https://anilist.co/graphiql and input the query below and replace `YOUR_USERNAME` with your username.
```gql
query {
User(name: "YOUR_USERNAME") {
id
name
}
}
```
The query above will return your username and your id which you can use for this action.
## Example
You can find it on my [profile](https://github.com/pxseu/pxseu/blob/a2980f3165f0ed86d5469ee35b8ff38e12116794/README.md)!