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

Uploaded Source

Built Distribution

cobib-1.0.2-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cobib-1.0.2.tar.gz
  • Upload date:
  • Size: 12.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/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.1

File hashes

Hashes for cobib-1.0.2.tar.gz
Algorithm Hash digest
SHA256 8c60cec03f02e15b31c73b5ad1c3456b649281af3569a193a11009ee7e786c2d
MD5 ed21c749d9af90d66b169a3c988e1e77
BLAKE2b-256 1375327943f6ba3fcdc0f149e10bf4cbdd107c47cbe80f54ea1d7226a1ea7301

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cobib-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 10.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 65a70df629975f2fb27d5c55291f77ba3f78029149d819ce70b62c0e36ffe876
MD5 846841a6f54ecfc95d15a0c0b2325152
BLAKE2b-256 b3fa52e459df9f53b1bf9cf5a140e46f4ceb4900c8c777822a1823bfddde36b9

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