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.0a2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

cobib-2.0.0a2-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cobib-2.0.0a2.tar.gz
  • Upload date:
  • Size: 22.6 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.0a2.tar.gz
Algorithm Hash digest
SHA256 43759ca6f17d59cb7df545e6f3a08ab89ae0e3823317acb2e30b01cff4e5b408
MD5 1281c5f5b94462d586b9e92ec1ef2e59
BLAKE2b-256 6243a62bf1a21facfd181572a1617cabffb0a4633597a00ac06d0bb90e6473d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cobib-2.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 28.7 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.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 bdc1e091baf443f6289c58697869860a8a75249efa25d45f62277ddf2ef66486
MD5 b478fa3a0d3101ebbc07534879b9581e
BLAKE2b-256 e9a3c3fa03ac769d4112cbf9f61b6c296be41d9a4d2d1dd049e49c7f263f7670

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