Skip to main content

A Decentralized Book Search Engine

Project description

Liber3: An Open Sourced Decentralized eBook Search Engine

Introducing Liber3, a tool for searching ebooks stored on IPFS. It's based on a decentralized data protocol - Glitter Protocol.

You could use Liber3 to search for IPFS links base on file names and displays search results with a simple interface.

There is also a web version of Liber3 works on ENS and IPFS available if you do not have Python environment.

Getting Started

To get started, please follow these steps:

Prerequisites

  • Python (v3.7 or higher)

Installation

Installing the tool, and you should make sure your/download/path in the $PATH, then you can use the command line tool.

pip install lib3

Options

  • terms:Specifies search terms to be queried. Required:yes.

  • -p <page> or --page <page>:Specifies the page of results to display. Default: 0.

  • -l <limit> or --limit <limit>:Specifies the number of per page to display. Default: 10.

  • -s <sort type> or --sort <sort type>:Specifies the sorting sequence of results to display. Default: none.

    • date :sort by the original publication time of the file
  • -t <filter type> or --type <fliter type>:Specifies the book extension of result to display. Default: all.

    • epub :epub extension.
    • pdf:pdf extension.
    • mobi :mobi extension.
    • azw3 :azw3 extension.
    • djvu :djvu extension.

Examples

  1. Search for keyword "algebra":
lib3 algebra
  1. Search for keywords "linear algebra" and page 1, limit 5:
lib3 "linear algebra" -p 1 -l 5 
  1. Search for keywords "linear algebra" and only keep the pdf resource:
lib3 "linear algebra" -t pdf

Built With

  • glitter-sdk-py A Python SDK for interacting with the Glitter Protocol.

Contributing

If you would like to contribute to this project, feel free to fork the repository and submit a pull request with your changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lib3-0.0.1.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

lib3-0.0.1-py3-none-any.whl (7.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page