Skip to content

A simple tool to download attachments/previews from CG-Wire Kitsu

License

Notifications You must be signed in to change notification settings

keshon/kitsu-file-parser

Repository files navigation

📂 Kitsu File Parser 🛠️

A simple and efficient tool to parse and download attachments/previews from CG-Wire Kitsu, built with Go! 🚀


✨ Features

  • 🌐 Authenticate with Kitsu using your credentials.
  • 📥 Download attachments and previews automatically.
  • 📂 Organize files into well-structured directories based on their metadata.
  • 🔄 Supports multi-threaded processing for faster execution.
  • 🛡️ Skips unnecessary files with configurable filters.

📦 Installation

  1. Clone the repository:

    git clone https://github.com/keshon/kitsu-file-parser
    cd kitsu-file-parser
  2. Build the application:

    go build -o kitsu-file-parser
  3. Run the binary:

    ./kitsu-file-parser

⚙️ Configuration

The tool uses a configuration file (config.toml) for customizable options.


🛠️ Usage

  1. Add your Kitsu credentials to the configuration file.
  2. Place config.toml in the project directory.
  3. Run the parser:
    ./kitsu-file-parser
  4. 🎉 Enjoy clean, organized file downloads!

📋 How It Works

  1. Authentication: Logs in to Kitsu and retrieves a token.
  2. Attachment/Preview Retrieval: Fetches metadata from Kitsu.
  3. File Download: Downloads files to the specified local directory.
  4. Organization: Organizes files based on project, entity, and task metadata.

🧾 License

This project is licensed under the MIT License. Feel free to use, modify, and share it!


❤️ Thank You!

If you find this project helpful, give it a ⭐ on GitHub.

About

A simple tool to download attachments/previews from CG-Wire Kitsu

Topics

Resources

License

Stars

Watchers

Forks