Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.52 KB

README.md

File metadata and controls

82 lines (53 loc) · 2.52 KB

PlmcBksAPI

PlmcBksAPI é uma API HTTP, feed RSS e catálogo OPDS escrito usando Python3 e o framework FastAPI.

Instâncias

Veja a lista de instâncias disponíveis ou adicione a sua própria na wiki.

Características

  • Possibilita a pesquisa e obtenção de informações sobre livros.
  • Possibilita o download de documentos e a visualização de imagens.

API

A API se baseia na estrutura de dados JSON e processa dados a partir de parâmetros em requisições GET e valores associados a URI.

OPDS

O catálogo OPDS se baseia na estrutura de dados XML e processa dados a partir de parâmetros em requisições GET e valores associados a URI. A especificação atualmente seguida é o OPDS 1.2.

RSS

O feed RSS se baseia na estrutura de dados XML e processa dados a partir de parâmetros em requisições GET. A especificação atualmente seguida é o RSS 2.0.

Instalação

As instruções a seguir assumem que você possui experiência com ambientes Linux e que também tem conhecimento básico sobre as APIs do Telegram.

Requisitos

  • Sistema operacional Linux
  • 200 MB de espaço em disco
  • 600 MB de memória
  • Python 3.6 ou superior

Instruções

  1. Comece realizando um clone deste repositório:
$ git clone --ipv4 \
   --single-branch \
   --no-tags \
   --depth '1' \
   'https://github.com/PolemicBooks/PlmcBksAPI' \
   ~/PlmcBksAPI
  1. Instale todas as dependências necessárias:
$ cd ~/PlmcBksAPI
$ python3 scripts/setup_dependencies.py
  1. Faça login usando sua conta no Telegram:

Isso será necessário para tornar o download de documentos e imagens através da API possível.

Para acessar a API do Telegram, você precisará de um api_id e um api_hash. Siga estas instruções para saber como obtê-las.

$ source virtualenv/bin/activate
$ python scripts/setup_account.py -h
usage: setup_account.py [-h] --api-id API_ID --api-hash API_HASH

optional arguments:
  -h, --help           show this help message and exit
  --api-id API_ID      telegram api id
  --api-hash API_HASH  telegram api hash

Apenas realize o login usando contas descartáveis. Embora as chances sejam baixas, sua conta ainda pode ser banida por abuso.

  1. Inicie a aplicação
$ python application.py

Leva em média 5 minutos para que a aplicação inicie.