Skip to main content
# pdfs
Simple Bibliography Database

## Introduction

This tool manages article PDFs. This tool is based on two working principles.
First, DOIs are central. Only documents with a DOI can be stored in the
database. All metadata is acquired through the [Crossref](https://crossref.org)
[API](https://github.com/CrossRef/rest-api-doc) through DOIs scraped from the
PDF or entered by the user. Second, document repositories are local to a
directory hierarchy. For example, if I have a project based in ~/projects/foo,
I can create a document repository by

cd ~/projects/foo
pdfs init

This creates a new direcory in ~/projects/foo called articles. All PDFs
imported into the database will be copied here. Running `pdfs` in
~/projects/foo, or any directory below it will use the repository at
~/projects/foo/articles.

## Commands

usage: pdfs command ...

| Command | Description |
|---------|--------------------------------------------|
| add | Import new PDF into repository |
| aux2bib | Read LaTeX .aux file and dump a .bib file |
| bibtex | Dump bibtex for keys |
| edit | Edit bibtex, metadata and file attachments |
| import | Import entries from other database |
| info | Print information about current repository |
| init | Initialize new document repository |
| list | List all items in database |
| search | Search full text of PDF |
| view | View article PDF and attachements |
| watch | Watch a directory for new pdf files to add |
| www | Spin up http server |


## Command line completion

Command line autocomplete support via
[argcomplete](https://argcomplete.readthedocs.io).

To start quickly with zsh:

autoload bashcompinit
bashcompinit
eval "$(register-python-argcomplete pdfs)"

Release files for pdfs 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pdfs 0.1.0
File Size Uploaded
pdfs-0.1.0.tar.gz 535.4 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for pdfs 0.1.0
File Interpreter ABI Platform
pdfs-0.1.0-py3.6.egg Legacy Egg format - - Details
pdfs-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.7 MB

Release files / pdfs-0.1.0.tar.gz

Download URL pdfs-0.1.0.tar.gz
Size 535.4 kB
Tags Source
SHA-256 checksum
How to use checksums
162e221076bd612d27f0b35717708f410f2d04424f085247a9557335963254b0
BLAKE2b-256 checksum
How to use checksums
b30599ac43fd0f859892f758afb4e31247014da45ace13fe0d50473e0fcc6138
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pdfs-0.1.0-py3.6.egg

Download URL pdfs-0.1.0-py3.6.egg
Size 622.2 kB
Tags Egg
SHA-256 checksum
How to use checksums
64dd7b9a3ad192a62e04b2ba07caccb1e3e5af62de18da289967718fbac5a7d7
BLAKE2b-256 checksum
How to use checksums
6ebcda6f7759bb56221e0c729638f2452d9b972e962a9a07da866b27f68a94a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pdfs-0.1.0-py3-none-any.whl

Download URL pdfs-0.1.0-py3-none-any.whl
Size 550.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1b26eab4b5646b47320a38e664b9e7d2c793ea04691def6e7a4989fb1a675ba4
BLAKE2b-256 checksum
How to use checksums
6daf5a871cd3b553e8a5cd2c54239675dad529da5a56ac5e12f98c7a464ebf88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0 This release

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page