| 0 |
Welcome to Open Library's Developer Center. |
0 |
Welcome to the developer hub of Open Library. This page links you to all of the information and external resources that will help you get started accessing data from, integrating with, or contributing to the Open Library platform. |
| 1 |
|
1 |
|
| 2 |
# Accessing Open Library Data |
2 |
**Accessing Data** |
|
|
3 |
Open Library offers free, public, low-volume [**Web APIs**][2] and **bulk** [**Monthly Data Dumps**](/data) for accessing book and author catalog data. Here are [examples](/developers/api#api-partners) of partners making use of our data in the wild. Our Web APIs are ideal for book services which need to make infrequent, real-time searches for specific books, their authors, and their availability. For projects which require importing books, authors, or covers in bulk, please kindly download our free data dumps. |
| 3 |
|
4 |
|
| 4 |
Open Library offers free public [APIs][2] and [Monthly Bulk Data Dumps] for accessing catalog data. |
5 |
**Client Libraries** |
|
|
6 |
We maintain an [**Official (Python) Client Library**](https://github.com/internetarchive/openlibrary-client) for accessing data and [writing bots](https://github.com/internetarchive/openlibrary-bots#openlibrary-bots). The are also unofficial client libraries written in [Ruby](https://github.com/jayfajardo/openlibrary) and [Elixir](https://github.com/nithinbekal/openlibrary). |
| 5 |
|
7 |
|
| 6 |
## [APIs][2] |
8 |
**Contributing** |
|
|
9 |
OpenLibrary.org is an open source project. If you'd like to contribute as an Open Library developer, please visit our [**CONTRIBUTING guide**](https://github.com/internetarchive/openlibrary/blob/master/CONTRIBUTING.md) on [GitHub](https://github.com/internetarchive/openlibrary) and explore our [**volunteer page**](https://openlibrary.org/volunteer). Aside from the documentation here, you may also find [Open Library's Docs site](https://docs.openlibrary.org) useful for getting started. |
| 7 |
|
10 |
|
| 8 |
* [Covers](docs/api/covers) |
11 |
**Technologies** |
| 9 |
* [Books](docs/api/books) |
12 |
Open Library is written in Python and uses the (now arcane) [Infogami](https://openlibrary.org/dev/docs/infogami) web framework, which itself is built on top of [web.py](https://webpy.org). |
| 10 |
* [API Sandbox](/api_sandbox) |
|
|
| 11 |
|
13 |
|
| 12 |
## Monthly Data Dumps |
14 |
**Partners** |
| 13 |
|
15 |
Are you a library, publisher, or book vendor trying to integrate your catalog with Open Library previews, lending, data, or book covers? Check out our [partner resources](/dev/docs/inlibrary). |
| 14 |
- [Bulk Download Open Library Bibliographic Data](data#bulk_download) |
|
|
| 15 |
|
|
|
| 16 |
## API Client Libraries |
|
|
| 17 |
|
|
|
| 18 |
- [The official Open Library Client (Python)][https://github.com/internetarchive/openlibrary-client] |
|
|
| 19 |
- [Ruby interface for the API](https://github.com/jayfajardo/openlibrary), written by Jay Fajardo |
|
|
| 20 |
|
|
|
| 21 |
## Friends Using Open Library APIs |
|
|
| 22 |
|
|
|
| 23 |
If you are using Open Library's [[APIs|OL APIs]], please email openlibrary@archive.org and let us know about how you are using them. |
|
|
| 24 |
|
|
|
| 25 |
- [**OpenBook Wordpress Plugin**][1] by [John Miedema](http://johnmiedema.ca)<br />Use the Open Library JSON API to inserts a book cover, title, author, and publisher in WordPress blogs. |
|
|
| 26 |
|
|
|
| 27 |
[1]: http://johnmiedema.ca/openbook-wordpress-plugin/ |
|
|
| 28 |
|
|
|
| 29 |
- [**Evergreen OpenLibrary added content plug-in**](http://svn.open-ils.org/trac/ILS/browser/trunk/Open-ILS/src/perlmods/OpenILS/WWW/AddedContent/OpenLibrary.pm) by [David Christensen] (mailto:david.a.christensen@gmail.com) and [Dan Scott] (mailto:dscott@laurentian.ca)<br />Uses the OpenLibrary JSON API to display book covers and tables of contents as part of the item display in the [Evergreen open-source library system](http://evergreen-ils.org). |
|
|
| 30 |
|
|
|
| 31 |
- [**Link to full text**](http://pegasus.law.columbia.edu/record=b386411) by [Ted Lawless] (mailto:lawlesst@gmail.com) <br /> Uses the OpenLibrary JSON API to dynamically insert links to full text titles into a library OPAC. |
|
|
| 32 |
|
|
|
| 33 |
# [Contributing to Open Library](https://github.com/internetarchive/openlibrary/wiki) |
|
|
| 34 |
|
|
|
| 35 |
## [Getting Started](https://github.com/internetarchive/openlibrary/blob/master/CONTRIBUTING.md) |
|
|
| 36 |
|
|
|
| 37 |
- [Set up a development instance of Open Library](https://github.com/internetarchive/openlibrary#installation) |
|
|
| 38 |
- [Github Issue Tracker](https://github.com/internetarchive/openlibrary/issues) ([old issue tracker](https://bugs.launchpad.net/openlibrary) on launchpad) |
|
|
| 39 |
- [Git Cheat Sheet: Committing changes to github.com/openlibrary/openlibrary](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet) (previously [/dev/docs/committing]) |
|
|
| 40 |
|
|
|
| 41 |
## Writing Bots |
|
|
| 42 |
|
|
|
| 43 |
- [Writing a Bot for Open Library](https://github.com/internetarchive/openlibrary-bots#openlibrary-bots) ([legacy bot docs](/dev/docs/bots)) |
|
|
| 44 |
|
|
|
| 45 |
### About the Technology |
|
|
| 46 |
|
|
|
| 47 |
Open Library is powered by [Infogami][4], a clean, simple wiki application framework built on [web.py][5]. Unlike other wikis, Infogami has the flexibility to handle different classes of data, including structured data. That makes it the perfect platform for Open Library. |
|
|
| 48 |
|
|
|
| 49 |
Open Library also uses a text-to-HTML formatting language [Markdown][7], created by John Gruber. We also use the handy [WMD][8] Markdown WYSIWYG editor. |
|
|
| 50 |
|
|
|
| 51 |
- [Infogami Developer Tutorial](/dev/docs/infogami) |
|
|
| 52 |
|
|
|
| 53 |
--- |
|
|
| 54 |
|
|
|
| 55 |
Open Library graciously uses [Browserstack][9] for cross browser compatibility testing, Github for hosting our public code repository, and Travis CI + Github Actions. |
|
|
| 56 |
|
16 |
|
| 57 |
[oldev]: /developers/ol |
17 |
[oldev]: /developers/ol |
| 58 |
|
18 |
|
| 59 |
[1]: http://mail.archive.org/cgi-bin/mailman/listinfo/ol-tech |
19 |
[1]: https://mail.archive.org/cgi-bin/mailman/listinfo/ol-tech |
| 60 |
[2]: http://openlibrary.org/developers/api |
20 |
[2]: https://openlibrary.org/developers/api |
| 61 |
[3]: http://openlibrary.org/dev/docs/api/covers |
21 |
[3]: https://openlibrary.org/dev/docs/api/covers |
| 62 |
[4]: https://openlibrary.org/dev/docs/infogami |
22 |
[4]: https://openlibrary.org/dev/docs/infogami |
| 63 |
[5]: http://webpy.org/ |
23 |
[5]: https://webpy.org/ |
| 64 |
[6]: http://infogami.org/quicklook |
24 |
[6]: https://infogami.org/quicklook |
| 65 |
[7]: http://daringfireball.net/projects/markdown/ |
25 |
[7]: https://daringfireball.net/projects/markdown/ |
| 66 |
[8]: http://wmd-editor.com/ |
26 |
[8]: https://wmd-editor.com/ |
| 67 |
[9]: https://www.browserstack.com/ |
27 |
[9]: https://www.browserstack.com/ |
|
