Skip to main content

Console Bibliography

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 or arXiv ID
  • 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-2.0.0b3.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

cobib-2.0.0b3-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file cobib-2.0.0b3.tar.gz.

File metadata

  • Download URL: cobib-2.0.0b3.tar.gz
  • Upload date:
  • Size: 23.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.2

File hashes

Hashes for cobib-2.0.0b3.tar.gz
Algorithm Hash digest
SHA256 9eb918298f641dc08703064924dab47c2fe2d6143aa33783ab9a1583d76f874f
MD5 9cd904b7b1bfd68121f672dc5a9c5e17
BLAKE2b-256 b93146c7cac0718b1734ae7081d2ed8449da7100fe481e02d0e3ae7e31c9c9c0

See more details on using hashes here.

File details

Details for the file cobib-2.0.0b3-py3-none-any.whl.

File metadata

  • Download URL: cobib-2.0.0b3-py3-none-any.whl
  • Upload date:
  • Size: 29.5 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/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.2

File hashes

Hashes for cobib-2.0.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 728b24ae2b6a26363ac6c4bc502b950be421a2813164bad68439d343101b1562
MD5 3b5a7582d4c9edfb8d7dc58a875d0e22
BLAKE2b-256 45cb517cfdf84910de57d78e42c57759cc01e018a44eed178684cafc4403a20c

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