Skip to main content

Console Reference Manager

Project description

CoBib

Welcome to CoBib - the Console Bibliography! I have started this project when I was looking into alternatives to popular reference managers such as Mendeley, which has more features than I use on a regular basis and does not allow me to work from the command line which is where I spent most of the time that I spent on the computer.

Hence, I have decided to make it my own task of implementing a simple, yet fast, reference manager. CoBib is written in Python and uses a YAML file to store its bibliography in a plain text format.

Currently CoBib provides the following functionality:

  • adding new references from a bibtex source or via DOI, arXiv ID or PDF
  • querying the database by in- and exclusion filters
  • printing detailed information about a reference ID
  • exporting a list of references to the biblatex format
  • opening associated files using an external program
  • manually editing entries using the $EDITOR

Future features may include:

  • previewing abstracts directly inside the terminal
  • extracting abstracts from PDFs

Installation

git clone https://gitlab.com/mrossinek/cobib
cd cobib
python setup.py install

This will install the cobib package. By default, cobib will store your database at ~/.local/share/cobib/literature.yaml

To see how you can change this, see Config.

Usage

Start by initializing the database with

cobib init

Afterwards you can add, list, edit, remove, show, open and export database entries. Type cobib --help for further information or cobib <subcommand> --help for more detailed information on the specific subcommands.

Config

You can overwrite the default configuration by placing a config.ini file at ~/.config/cobib/. Take a look at the default config to see what possible configuration options exist.

You may also specify a different config file at runtime by using the -c or --config command line argument.

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

cobib-1.0.0.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

cobib-1.0.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file cobib-1.0.0.tar.gz.

File metadata

  • Download URL: cobib-1.0.0.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.1

File hashes

Hashes for cobib-1.0.0.tar.gz
Algorithm Hash digest
SHA256 40b38964e6a45544d220bac76524077dfea27e09bbb0a3a60396168f62c6a70e
MD5 a0061b7387b0de9c342e9b72dfe26069
BLAKE2b-256 d30472fff9ea36711f39b152e9a4482efdb56ebe858914b5af8ece4e3d902645

See more details on using hashes here.

File details

Details for the file cobib-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: cobib-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.1

File hashes

Hashes for cobib-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d91c5c548b0014717a1223674947d0e7a3f9f54fa69380ce3a5600820e5c6822
MD5 c2efee9fb184144592eeac670880a339
BLAKE2b-256 8b4e7c516c2cc8976dafb4a1b6098a36feb82194761c648ab3c35a2f3a587186

See more details on using hashes here.

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