Giter VIP home page Giter VIP logo

mal's Introduction

๐ŸŒณ Mal

This is mal, a tool to interact with MyAnimeList.net. I have put it into a command branch for inclusion into my c Bonzai stateful command tree.

This branch is still very much a work in progress. PRs welcome.

Installation

This branch can be composed into any Bonzai stateful command tree.

If you just want to try it out, grab the release binary with curl and put into your PATH:

curl -L https://github.com/tr00datp00nar/mal/releases/latest/download/mal-linux-amd64 -o ~/.local/bin/mal
curl -L https://github.com/tr00datp00nar/mal/releases/latest/download/mal-darwin-amd64 -o ~/.local/bin/mal
curl -L https://github.com/tr00datp00nar/mal/releases/latest/download/mal-darwin-arm64 -o ~/.local/bin/mal
curl -L https://github.com/tr00datp00nar/mal/releases/latest/download/mal-windows-amd64 -o ~/.local/bin/mal

Authentication

In order to create a client ID and secret for your application:

  1. Navigate to https://myanimelist.net/apiconfig or go to your MyAnimeList profile, click Edit Profile and select the API tab on the far right.
  2. Click Create ID and submit the form with your application details.

You will need to create a config file $HOME/.config/mal/mal.yaml with the following content:

client_id: "YOUR-CLIENT-ID"
client_secret: "YOUR-CLIENT-SECRET"

This config location is currently hardcoded. PRs welcome to place configuration elsewhere.

Resources

To learn more about Bonzai stateful command trees: https://github.com/rwxrob/bonzai

To see my personal Bonzai stateful command tree: https://github.com/tr00datp00nar/c

To see the original Bonzai stateful command tree z: https://github.com/rwxrob/z

To-do

  • Allow user to define custom configuration and token cache locations.
  • Allow user to change filters/sorting.
  • Create some kind of nice looking UI to display to returned API data.

mal's People

Contributors

tr00datp00nar avatar

Watchers

James Cloos avatar Kostas Georgiou avatar  avatar

mal's Issues

README.md instructs users to create config in wrong location and format

This issue applies only to the nagato branch.

The readme indicates that users should create a configuration file at $XDG_CONFIG_HOME/mal/mal.yaml but the application actually looks for configuration at $XDG_CONFIG_HOME/c/config.yaml.

Would be preferable to allow the user to set the configuration location themselves rather than having a hard-coded one.

Alternatively, we could look for configuration in multiple locations, allowing the user to create configuration in whichever location they prefer.

  • $XDG_CONFIG_HOME/mal/config.yaml
  • $HOME/.mal/config.yaml
  • /etc/mal/config.yaml
  • $CWD/config.yaml

If composed into a bonzai tree, we need a way to allow the user to use a single configuration file for their entire monolith. (This is the original reason that the program looks for $XDG_CONFIG_HOME/c/config.yaml)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.