Updated README and cleaned repo
This commit is contained in:
parent
41d8fb16d9
commit
052f39b6f2
2
.gitignore
vendored
2
.gitignore
vendored
@ -5,3 +5,5 @@
|
||||
*~
|
||||
.*.sw*
|
||||
|
||||
params.py
|
||||
translation-server
|
||||
|
57
README.md
57
README.md
@ -1,27 +1,52 @@
|
||||
Forked from https://github.com/a3nm/paperbot
|
||||
# paperbot
|
||||
BiblioManager
|
||||
=============
|
||||
|
||||
Paperbot is an command line utility that fetches academic papers. When given a URL on stdin or as a CLI argument, it fetches the content and returns a public link on stdout. This seems to help enhance the quality of discussion and make us less ignorant.
|
||||
BiblioManager is a simple script to download and store your articles. This is mostly based upon [the paperbot fork from a3nm](https://github.com/a3nm/paperbot).
|
||||
|
||||
Paperbot can easily be turned back into an IRC bot with [irctk](http://gitorious.org/irctk)
|
||||
**Note :** This script is currently a work in progress.
|
||||
|
||||
<div id="details" />
|
||||
<div id="deets" />
|
||||
## deets
|
||||
## What is BiblioManager (or what it is **not**) ?
|
||||
|
||||
I used to have a folder with poorly named papers and books and wanted something to help me handle it. I don't like Mendeley and Zotero and so on, which are heavy and overkill for my needs. I just want to feed a script with PDF files of papers and books, and I want it to automatically maintain a BibTeX index of these files, to help me cite them and find them back.
|
||||
|
||||
This is the goal of BiblioManager. It will :
|
||||
* Download or import PDF files (but also epub, djvu etc.)
|
||||
* Try to get automatically the metadata of the files (keywords, author, review, …)
|
||||
* Store all the metadata in a BibTex file
|
||||
* Rename your files to store them in a logical and homogeneous way
|
||||
* Help you find them back
|
||||
* Give you directly the bibtex entry necessary to cite them
|
||||
|
||||
BiblioManager will always use standard formats such as BibTeX, so that you can easily edit your library, export it and manage it by hand, even if you quit this software for any reason.
|
||||
|
||||
|
||||
## Installation
|
||||
TODO -- To be updated
|
||||
|
||||
|
||||
Install pdfminer, pdfparanoia (via pip) and requesocks.
|
||||
Init the submodules and install Zotero translation server.
|
||||
Copy params.py.example as params.py and customize it.
|
||||
|
||||
|
||||
## Paperbot
|
||||
|
||||
Paperbot is a command line utility that fetches academic papers. When given a URL on stdin or as a CLI argument, it fetches the content and returns a public link on stdout. This seems to help enhance the quality of discussion and make us less ignorant.
|
||||
|
||||
All content is scraped using [zotero/translators](https://github.com/zotero/translators). These are javascript scrapers that work on a large number of academic publisher sites and are actively maintained. Paperbot offloads links to [zotero/translation-server](https://github.com/zotero/translation-server), which runs the zotero scrapers headlessly in a gecko and xulrunner environment. The scrapers return metadata and a link to the pdf. Then paperbot fetches that particular pdf. When given a link straight to a pdf, which paperbot is also happy to compulsively archive it.
|
||||
|
||||
I kept part of the code to handle pdf downloading, and added a backend behind it.
|
||||
|
||||
Paperbot can try multiple instances of translation-server (configured to use different ways to access content) and different SOCKS proxies to retrieve the content.
|
||||
|
||||
* [zotero/translators](https://github.com/zotero/translators)
|
||||
* [zotero/translation-server](https://github.com/zotero/translation-server)
|
||||
* [patched translation-server](https://github.com/kanzure/translation-server)
|
||||
* [phenny](https://github.com/sbp/phenny)
|
||||
* [pdfparanoia](https://github.com/kanzure/pdfparanoia)
|
||||
|
||||
<div id="license" />
|
||||
## license
|
||||
## Used source codes
|
||||
|
||||
BSD.
|
||||
Original project is: https://github.com/kanzure/paperbot
|
||||
* [zotero/translators](https://github.com/zotero/translators) : Links finder
|
||||
* [zotero/translation-server](https://github.com/zotero/translation-server) : Links finder
|
||||
* [pdfparanoia](https://github.com/kanzure/pdfparanoia) : Watermark removal
|
||||
|
||||
|
||||
## License
|
||||
|
||||
TODO
|
||||
|
@ -1,4 +1,4 @@
|
||||
#!/usr/bin/python -u
|
||||
#!/usr/bin/python2 -u
|
||||
# coding=utf8
|
||||
"""
|
||||
Fetches papers.
|
||||
|
@ -1,3 +0,0 @@
|
||||
requesocks
|
||||
-e git://github.com/kanzure/pdfparanoia.git@master#egg=pdfparanoia
|
||||
copy params.py.example as params.py and customize it
|
Loading…
Reference in New Issue
Block a user