Giter Club home page Giter Club logo

ao3_api's Introduction

ao3-api

An unofficial JavaScript API for Archive of Our Own (AO3). Based on the Python version by Armindo Flores. The goal was to emulate the Python version as closely as possible, but with the added benefit of being able to use it natively in Node.js (for my Discord bot). None of the code has been rigorously tested, so don't expect it to work perfectly. If you find any bugs, please open an issue and I'll do my best to fix it.

The library is kind of barebones and only includes the things I need (works, chapters, users, sessions, and searches). I will probably be adding other features slowly but don't expect anything too soon.

Installation

npm install ao3

Usage

const AO3 = require('ao3');

There is no base AO3 constructor. You must call a static class under AO3, for example, AO3.Work() or AO3.Search().

const AO3 = require('ao3');

// Get a work by ID
const work = new AO3.Work(12345678);
work.reload().then(() => {
    console.log(work.title);
});

Testing

There are a bunch of files in the test directory. They're all named after the function they're testing. If you want, you can create a .env file in that directory and AO3_USER=<your username> and AO3_PASS=<your password> so you have access to restricted works. If you don't, you'll only be able to access public works.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

License

MIT

"no typescript? *megamind staring through peephole* i waaaannt typescript! ๐Ÿค“"

Did I ask? No autocomplete for you! No type-checking for you! No IntelliSense for you! No nothing! You're on your own, buddy! Screw you!

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.