{ "info": { "author": "Tom Gurion", "author_email": "nagasaki45@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Database :: Front-Ends", "Topic :: Education", "Topic :: Scientific/Engineering", "Topic :: Text Processing :: Markup :: LaTeX", "Topic :: Utilities" ], "description": "Bibo\n####\n\n.. image:: https://travis-ci.org/Nagasaki45/bibo.svg?branch=master\n :target: https://travis-ci.org/Nagasaki45/bibo\n\n.. image:: https://codecov.io/gh/Nagasaki45/bibo/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/Nagasaki45/bibo\n\n\nA reference manager with a single source of truth: the ``.bib`` file. Inspired by `beets`_.\n\n\nWhy?\n----\n\nThere are many reference managers out there, so why writing another one? Bibo is different for a few reasons:\n\n1. It relies solely on your ``.bib`` file to track information. This is bibo's main selling point! Your ``.bib`` file and your other files (PDFs, for example) are exactly where you want them to be. You have full control over your data.\n2. Being a command line tool, integration with other command line applications is easy and powerful.\n3. It's extensible with plugins (more on this later).\n\n\nInstallation\n-------------\n\nPrerequisites\n=============\n\n1. On linux, make sure to install ``xclip``.\n2. Optionally, define the ``EDITOR`` environment variable to an editor of your choice (this is usually already set on unix systems).\n3. Optionally, for improved presentation, install ``bibtex``.\n\n\n``pip`` installation\n====================\n\n.. code-block:: bash\n\n pip install bibo\n\n\nOn linux / mac you might need to prepend the above command with ``sudo`` for system wide installation, or, preferably, use the ``--user`` flag like this:\n\n.. code-block:: bash\n\n pip install --user bibo\n\n\nFor more information see the `official packages installation guide`_.\n\n\nQuick start guide\n-----------------\n\n\nThe ``--database`` argument\n===========================\n\nWhen running bibo you should tell it where your ``.bib`` file is. For example, to list the entries in your database, run\n\n.. code-block:: bash\n\n bibo --database /path/to/your/database.bib list\n\nIf you don't yet have a ``.bib`` file, or want to start working on a new one pass a path to where you want your ``.bib`` file to be and bibo will create the new file for you.\n\n\nThe ``BIBO_DATABASE`` environment variable\n==========================================\n\nMost of the time you will probably use the same ``.bib`` file. So, instead of passing the ``--database`` argument whenever you call bibo you can define the ``BIBO_DATABASE`` environment variable with the path to your ``.bib`` file. From now on, if you don't pass the ``--database`` argument explicitly, bibo will use this predefined database. Note that this is the only bit of configuration bibo uses. Everything else is in your ``.bib`` file!\n\nCommands\n========\n\nWe already saw the ``list`` command. To check all of bibo's commands run\n\n.. code-block:: bash\n\n bibo --help\n\n\nTo read additional information about each command and its arguments run, for example\n\n.. code-block:: bash\n\n bibo list --help\n\n\nLet's go through some of the less obvious commands.\n\n\n``add``\n~~~~~~~\n\nTo add a new entry to the database, copy the ``bibtex`` citation from, let's say, google scholar, and run\n\n.. code-block:: bash\n\n bibo add\n\nBibo will open your editor and paste the clipboard content to it. You are free to edit this content and save it to add the entry to the database.\n\nIf you want to include a file (a PDF, for example) run the same command with ``--file /path/to/file`` at the end. After saving the bibtex citation in the editor bibo will search through the already existing paths in your database, find the most commonly used one, and copy the file you specified to there, renaming it to the bibtex key. If you don't want this automatic destination heuristic you can specify the destination yourself by adding ``--destination /path/to/folder/``.\n\n\n``open``\n~~~~~~~~\n\nTry running\n\n.. code-block:: bash\n\n bibo open Albert Einstein\n\n\nIf you have a single entry in the database by Albert Einstein (more about search terms below), and the ``file`` field is defined, bibo will open this file with an appropriate application. If it's a PDF it will probably be your PDF reader. But it can also be a presentation, ``.zip`` file, or even a folder.\n\n\n``edit``\n~~~~~~~~\n\nThe ``edit`` command allows you to edit a single entry. You can set the type by running, for example\n\n.. code-block:: bash\n\n bibo edit Albert Einstein --type article\n\nSetting the key is the same.\n\nTo edit a field run, for example\n\n.. code-block:: bash\n\n bibo edit Albert Einstein --field title\n\nYour editor will open with the current content of the title field (or empty if there was no title). Saving will update the database.\n\nThe ``edit`` command is also used to link a file to the entry. It is done exactly the same way as the ``add`` command.\n\n\n``SEARCH_TERMS``\n================\n\nMost of bibo's commands expect you to provide search terms. Some of them, like the ``open`` command, will only work if the search terms matches a single entry in the database. A single search term matches an entry if it appears in the type, key, or any of the fields of the entry. If multiple search terms are provided an entry should match all of them. Note that search terms are case insensitive. In addition, it is possible to match against a specific field with, for example ``author:einstein`` or ``year:2018``. You can match against type / key in a similar fashion, with, let's say ``type:book``.\n\n\n.. _beets: https://github.com/beetbox/beets\n.. _`official packages installation guide`: https://packaging.python.org/tutorials/installing-packages/\n\n\nAuto-complete\n=============\n\nTo activate auto-complete, if you're using Bash add the following to your ``.bashrc``\n\n.. code-block:: bash\n\n eval \"$(_BIBO_COMPLETE=source bibo)\"\n\nIf you're on zsh add this to your ``.zshrc``\n\n.. code-block:: bash\n\n eval \"$(_BIBO_COMPLETE=source_zsh bibo)\"\n\nNow, while in the middle of a command, press to auto-complete options, arguments, or keys from your ``.bib`` database.", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Nagasaki45/bibo", "keywords": "bib latex reference interface", "license": "", "maintainer": "", "maintainer_email": "", "name": "bibo", "package_url": "https://pypi.org/project/bibo/", "platform": "", "project_url": "https://pypi.org/project/bibo/", "project_urls": { "Homepage": "https://github.com/Nagasaki45/bibo" }, "release_url": "https://pypi.org/project/bibo/0.0.18/", "requires_dist": null, "requires_python": "", "summary": "A reference manager with single source of truth: the .bib file. Inspired by beets", "version": "0.0.18" }, "last_serial": 5439886, "releases": { "0.0.10": [ { "comment_text": "", "digests": { "md5": "654b4b8ecb91d6a4cb2b4ac6c3a9e1f2", "sha256": "52d0cf099c3d36a3e82fec8acaf47c5b74a6454d847a8fb959877f19cd6cab70" }, "downloads": -1, "filename": "bibo-0.0.10.tar.gz", "has_sig": false, "md5_digest": "654b4b8ecb91d6a4cb2b4ac6c3a9e1f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6442, "upload_time": "2018-12-26T17:28:44", "url": "https://files.pythonhosted.org/packages/22/12/66ef577a132243a26a1e07dc1c363cdaa09f4a386b6b8f992bf002c3868e/bibo-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "a384f0296d44c41c22f137e20f134275", "sha256": "7ad8ed1dc33e08ef97d2021bce1ecabf7ee485c99ade81761a4373473e67b986" }, "downloads": -1, "filename": "bibo-0.0.11.tar.gz", "has_sig": false, "md5_digest": "a384f0296d44c41c22f137e20f134275", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6441, "upload_time": "2018-12-26T17:41:39", "url": "https://files.pythonhosted.org/packages/dc/be/1f4d3048a7ef452519e11725cb337200eea4d1454042ff9be6ee037a4c91/bibo-0.0.11.tar.gz" } ], "0.0.12": [ { "comment_text": "", "digests": { "md5": "2370827fed42209154e3eda9fc333e81", "sha256": "8370d595b0dd7fc7db70370ab0605805adb0089263fb6776a5b1f03dc687e7f8" }, "downloads": -1, "filename": "bibo-0.0.12.tar.gz", "has_sig": false, "md5_digest": "2370827fed42209154e3eda9fc333e81", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8150, "upload_time": "2018-12-29T20:10:37", "url": "https://files.pythonhosted.org/packages/42/3a/440807ce289b844daaa4b89e2ab7daf9355d06ebcf1e896c355ac9d1d77a/bibo-0.0.12.tar.gz" } ], "0.0.13": [ { "comment_text": "", "digests": { "md5": "7b01f316890d36d59a4b71a3dfda2d50", "sha256": "9950c5b9c522c086ae7ce561b05415aa76d19065b64170fbb25b24e67571deb2" }, "downloads": -1, "filename": "bibo-0.0.13.tar.gz", "has_sig": false, "md5_digest": "7b01f316890d36d59a4b71a3dfda2d50", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10403, "upload_time": "2019-01-13T15:43:24", "url": "https://files.pythonhosted.org/packages/f6/7e/77f430475ea5180edcd310271d5de50b42410124b6dd7abc99e751580789/bibo-0.0.13.tar.gz" } ], "0.0.14": [ { "comment_text": "", "digests": { "md5": "eb4a4d040b11d715648e546e1c236cec", "sha256": "2e25d0ee653095f4205348446e63d9405a05e7eef1bd4aca97a4e25ac5607dfa" }, "downloads": -1, "filename": "bibo-0.0.14.tar.gz", "has_sig": false, "md5_digest": "eb4a4d040b11d715648e546e1c236cec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10460, "upload_time": "2019-02-26T16:16:49", "url": "https://files.pythonhosted.org/packages/4d/73/9f004f784303fd33939bcc63a22aafdd01a6eeb6a53c88e9412e091ae4b0/bibo-0.0.14.tar.gz" } ], "0.0.15": [ { "comment_text": "", "digests": { "md5": "dfae1ea4694d51063c9eb60b99a593fd", "sha256": "0c61ef254edc42ea003456bf48523ae526a2fc261ef0bd1b4d3331d7b7b4a45b" }, "downloads": -1, "filename": "bibo-0.0.15.tar.gz", "has_sig": false, "md5_digest": "dfae1ea4694d51063c9eb60b99a593fd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11470, "upload_time": "2019-03-30T21:56:11", "url": "https://files.pythonhosted.org/packages/75/ec/fbaeee3d17e1d8d96aaa0d2111d9c3a0c200eccb281b901c6a79ce7c7393/bibo-0.0.15.tar.gz" } ], "0.0.16": [ { "comment_text": "", "digests": { "md5": "d5c93f95dab98283651f5fbbef439b8d", "sha256": "14354613767533ac990d89117a8ad19fd0006dee00058d85dcf649852f3f2237" }, "downloads": -1, "filename": "bibo-0.0.16.tar.gz", "has_sig": false, "md5_digest": "d5c93f95dab98283651f5fbbef439b8d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11926, "upload_time": "2019-06-07T10:27:38", "url": "https://files.pythonhosted.org/packages/df/78/c115957f125341227868f88049a10dd41877ec255cf68a19e8956c483a03/bibo-0.0.16.tar.gz" } ], "0.0.17": [ { "comment_text": "", "digests": { "md5": "9b65f3a6135512e79eb297b882efbf7b", "sha256": "8be54ece2f21483af976e4ab31d7a87538fde2c371ad64ad0a23004f48a7928e" }, "downloads": -1, "filename": "bibo-0.0.17.tar.gz", "has_sig": false, "md5_digest": "9b65f3a6135512e79eb297b882efbf7b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11914, "upload_time": "2019-06-07T10:32:53", "url": "https://files.pythonhosted.org/packages/fd/60/710d8426ffc0aced7e289084a1397d00cdc883f0734fcdbe25a4779dde8c/bibo-0.0.17.tar.gz" } ], "0.0.18": [ { "comment_text": "", "digests": { "md5": "76501142e7c1bb04a559cf31ee072198", "sha256": "854dfe4ecb462fc06a3b0d96c15c41f3a040245efca2ba6c07f731b0ec8e3b01" }, "downloads": -1, "filename": "bibo-0.0.18.tar.gz", "has_sig": false, "md5_digest": "76501142e7c1bb04a559cf31ee072198", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11831, "upload_time": "2019-06-24T09:45:32", "url": "https://files.pythonhosted.org/packages/74/25/610ace6f3142abcd729aac1f3c95493e38d2cd95717d8ea2f1480a42253a/bibo-0.0.18.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "be3716e7ed87c78132ec7167fa3c5cf8", "sha256": "2eb6d993ba42ebe256b52cf1b35a4269329740d1a4ffde8ad175c0c9755d3f27" }, "downloads": -1, "filename": "bibo-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "be3716e7ed87c78132ec7167fa3c5cf8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5048, "upload_time": "2018-11-20T14:19:27", "url": "https://files.pythonhosted.org/packages/7e/38/4168ceef815eef00f905b98012bc5360b6595d5cab4d3659c4226923de8a/bibo-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "49d8e3533a131583230c9e65462142a8", "sha256": "c69c31c4b67c01b8af565192eda32c34b304caecc65b6a48e36084b2f817c9c0" }, "downloads": -1, "filename": "bibo-0.0.3.tar.gz", "has_sig": false, "md5_digest": "49d8e3533a131583230c9e65462142a8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4546, "upload_time": "2018-11-20T14:19:29", "url": "https://files.pythonhosted.org/packages/3f/95/596bcc07660a511f13e557e1e8cf940ba9ad0ae1b84826578a8a6712a2ea/bibo-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "a982de385a81e156646baae1001ce2c8", "sha256": "fe66005d8082d8f164de831d4685ece689d5f5a45f536d5ee9fcc6fa49e4efe2" }, "downloads": -1, "filename": "bibo-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "a982de385a81e156646baae1001ce2c8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4932, "upload_time": "2018-11-26T21:04:48", "url": "https://files.pythonhosted.org/packages/42/05/a113fadb672f3bf0808d4265b76fb4b94bf34742226580348a91c4cbd369/bibo-0.0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "06d9d0cf44d1f0f0bbbada9735c0fd93", "sha256": "f41b7d42303a499a3b996a67349d39bfa2d49c447f83abcabcfae110042e6ad2" }, "downloads": -1, "filename": "bibo-0.0.4.tar.gz", "has_sig": false, "md5_digest": "06d9d0cf44d1f0f0bbbada9735c0fd93", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4432, "upload_time": "2018-11-26T21:04:49", "url": "https://files.pythonhosted.org/packages/6c/bb/cd5c3e2c3171ad68b559e7cdb083d5c6521dd5954ef0e1521480a64ca3c4/bibo-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "0151b4062999bec91628fc0612758b17", "sha256": "fd5c631a3e6fbabdf9d69555581f3dfcc0b62c4b66b739d5053721286f523a6f" }, "downloads": -1, "filename": "bibo-0.0.5.tar.gz", "has_sig": false, "md5_digest": "0151b4062999bec91628fc0612758b17", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4428, "upload_time": "2018-11-27T00:33:02", "url": "https://files.pythonhosted.org/packages/b8/7d/8cb7e8250da87fc8d1bc9829d26dc4a21467e423d7400201ad6460dfca0e/bibo-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "d162518474d1c4c9e9fa919d6ff5b04a", "sha256": "3e42631fa55b7569d32eba875afc920d5e1465cfd4dfd44ff62124ca01c976b7" }, "downloads": -1, "filename": "bibo-0.0.6.tar.gz", "has_sig": false, "md5_digest": "d162518474d1c4c9e9fa919d6ff5b04a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4762, "upload_time": "2018-11-28T10:57:19", "url": "https://files.pythonhosted.org/packages/2c/97/057cc4d83786b7c20c85b23826b5ba2079db7df61b561e9af4a4fa84af14/bibo-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "a6195b01ff94dc796eafcdeff3ca6bcd", "sha256": "ae1f383187a36ac63309b79052f3d59aedb040061d90428be9d4dbd5dee2029b" }, "downloads": -1, "filename": "bibo-0.0.7.tar.gz", "has_sig": false, "md5_digest": "a6195b01ff94dc796eafcdeff3ca6bcd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5241, "upload_time": "2018-11-29T19:09:25", "url": "https://files.pythonhosted.org/packages/4b/11/d1dbc4d7703bb6386a2c99d07fec1c8d5ba9b1c3a70c820e1e6510773662/bibo-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "5e2d01bc81340f88cf9ae242dec813ea", "sha256": "b5ea57837ad5b7df476e47a7f5413e84b85778af047ce4f232bbdac75d813ebc" }, "downloads": -1, "filename": "bibo-0.0.8.tar.gz", "has_sig": false, "md5_digest": "5e2d01bc81340f88cf9ae242dec813ea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5242, "upload_time": "2018-12-05T17:54:01", "url": "https://files.pythonhosted.org/packages/93/01/7acf1c5274f1619bd5cc0cb10eea0f6ff3088219f996a429ed4bb7280639/bibo-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "c18c77ab50e597090cb8df16a94fde2f", "sha256": "1bd610de5cfb6dfccf00c7e769a86b5b0363d69217ff4c01ffb23182b6a4de7b" }, "downloads": -1, "filename": "bibo-0.0.9.tar.gz", "has_sig": false, "md5_digest": "c18c77ab50e597090cb8df16a94fde2f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5252, "upload_time": "2018-12-19T00:20:50", "url": "https://files.pythonhosted.org/packages/85/fb/570a6a764c6f8bc1b41eb60d52b2c2b59cc4a7608b6245ba6cf7a4380319/bibo-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "76501142e7c1bb04a559cf31ee072198", "sha256": "854dfe4ecb462fc06a3b0d96c15c41f3a040245efca2ba6c07f731b0ec8e3b01" }, "downloads": -1, "filename": "bibo-0.0.18.tar.gz", "has_sig": false, "md5_digest": "76501142e7c1bb04a559cf31ee072198", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11831, "upload_time": "2019-06-24T09:45:32", "url": "https://files.pythonhosted.org/packages/74/25/610ace6f3142abcd729aac1f3c95493e38d2cd95717d8ea2f1480a42253a/bibo-0.0.18.tar.gz" } ] }