https://github.com/rangerdigital/neko-box

😺 Pinnable dynamic Gist with your latest AniList activity.
https://github.com/rangerdigital/neko-box

activity anilist anilist-api anime docker gists github github-actions pinned-gist profile python3

Last synced: 21 days ago
JSON representation

😺 Pinnable dynamic Gist with your latest AniList activity.

• Host: GitHub
• URL: https://github.com/rangerdigital/neko-box
• Owner: RangerDigital
• License: gpl-3.0
• Created: 2020-02-04T19:01:07.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-22T12:12:39.000Z (about 1 year ago)
• Last Synced: 2024-05-01T19:23:02.741Z (8 months ago)
• Topics: activity, anilist, anilist-api, anime, docker, gists, github, github-actions, pinned-gist, profile, python3
• Language: Python
• Homepage: https://github.com/RangerDigital
• Size: 59.6 KB
• Stars: 27
• Watchers: 2
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Neko-Box

  
Pinnable dynamic Gist with your latest AniList activity!


***

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

**Neko-Box** is a simple **GitHub Action** built to make dynamic Gist displaying your latest activity from AniList. 




## 🎉 Usage

**To start, you need to prepare some things:**

- Create a new public GitHub Gist at https://gist.github.com/

- Create an Access Token with the `gist` scope and save it.

You can do that at https://github.com/settings/tokens/new




**After getting this done:**

- Fork this repository.

- Go to your fork's **Settings > Secrets** page add the following secrets:

	- **`ANILIST_USERNAME`** - Your username from AniList.

	- **`GH_TOKEN`** - The access token you saved earlier.

	- **`GIST_ID`** - The ID of your newly created public Gist.

   *It will look like this:*  

	 `https://gist.github.com/RangerDigital/`**`d1b79f73d3e5a2420ed370b0059dba42`**.

 - Delete a `.github/workflows/schedule.yml` file.

 - Create a `.github/workflows/neko-box.yml` file like this:

 ```yml

 name: Update GitHub Gist with Neko-box!

 on:

   schedule:

     - cron: '*/10 * * * *'

 jobs:

   build:

     runs-on: ubuntu-latest

     steps:

       - uses: actions/checkout@master

       - name: Update activity from AniList

         uses: rangerdigital/neko-box@master

         with:

           GH_TOKEN: ${{ secrets.GH_TOKEN }}

           GIST_ID: ${{ secrets.GIST_ID }}

           ANILIST_USERNAME: ${{ secrets.ANILIST_USERNAME }}

 ```




**That's It!**  

Now every 10 minutes `neko-box.yml` workflow will update your Gist,  

It's now a good idea to pin it in your profile to show off your weeb power level!






	






## 🚧 Contributing

**You are more than welcome to help me improve Neko-Box!**

Just fork this project from the `master` branch and submit a Pull Request (PR).




## 📃 License

This project is licensed under [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) .