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-1.1.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

cobib-1.1.0-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cobib-1.1.0.tar.gz
  • Upload date:
  • Size: 13.9 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-1.1.0.tar.gz
Algorithm Hash digest
SHA256 b328d6f8cc3adf2ece9651247c48d0e6e0109edd5bd7b922392201c66acbf2f9
MD5 34c45b4e5e14488ef4f36fe83012c781
BLAKE2b-256 b2651de800a46789a589b49955ddc95cc50fc8430f2ceb3095fcd2098d074b77

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cobib-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.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-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3aba5028ff39721bf444bd27639a34cccef37ef925aff1ee205a4672482a35c0
MD5 cec3f43bf05d72c049986f636fd0e38c
BLAKE2b-256 81da2dd08c90923639c3359d4478ff39cda5021246f67c6210f507b283912eda

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