internetarchive / openlibrary-bots

A repository of cleanup bots implementing the openlibrary-client
Other
62 stars 49 forks source link

example workflow

openlibrary-bots

Open Library is an open, editable library catalog, building towards a web page for every book ever published. This repository contains cleanup bots implementing the openlibrary-client which allow developers to add/edit/remove different works/editions on Open Library.

Table of Contents

Overview

Open Library is an effort started in 2006 to create "one web page for every book ever published". It provides access to many public domain and out-of-print books, which can be read online.

Installation

First, fork the OpenLibrary repo to your own Github account and clone your forked repo to your local machine:

git clone git@github.com:YOURACCOUNT/openlibrary-bots.git

Enter the project directory using the following commands:

cd openlibrary-bots/

Developer's Guide

For instructions on administrating your Open Library instance and build instructions for developers, refer the Developer's Getting Started with Bots Guide.

You can also find more information regarding Developer Documentation for Open Library in the Open Library Wiki

Typically every folder signifies a different bot. The folder must contain code with respect to the bot, a README.md file which tells the user how to run the bot and any dependencies or requirements.txt file which can make it easier for a user to run the bot.

Contributing

Check out our contributor's guide to learn how you can contribute!

License

All source code published here is available under the terms of the GNU Affero General Public License, version 3. Please see http://gplv3.fsf.org/ for more information.

Current Active Bots

Inactive Bots