# citerus
A command-line tool to easily find cryptographic citations to use with LaTeX.
.-.
/ .\
.' . .'.
.-'. . . '-._
.' .. . . . . '.
/. . . . .\
/ . . . . .. . . \
|. . . .. . . ... |
/ . . . . . .\
| . . ._______ .. . . . ..|
| . / \ . . . . |
|. . { CITERUS }. .. . ..|
|. . \_______/. . ..|
| . . . . . . . |
|. . . .. . . ..|
\ . . . . . . . /
| . . . . . . . |
\. . . . . .. . .'
\ .. .. . . /
':_ . . . ... _.'
'-.. . . .-'
'._..'
# What does Citerus do?
Citerus retrieves your citations.
(_How do I pronounce it?_ Like so: /saɪt.rəs/)
When writing cryptographic papers, authors often use the excellent [cryptobib](https://cryptobib.di.ens.fr/) database. Since it consists of a large file, it is not often convenient to search in it. If you like the command line but you find grep awkward then citerus might be for you.
**Example:**
Suppose you want to find relevant citations for _round complexity in MPC_, just:
- Type `citerus mpc round` in your terminal
- Select all the papers that you find relevant (see screenshot). Exit the program.
Citerus will automatically copy in your clipboard the relevant LaTeX code to cite them.
That's it!
![Screenshot of citerus in action]([http://url/to/img.png](https://drive.google.com/file/d/1hNcfJLHTg_axQmjc4V1GyQ4ED7TCFdMs/view?usp=sharing))
To see more options and examples type `citerus --help`.
# Installing
`pip install citerus`
If you don't have pip, install it first with `python -m ensurepip --upgrade`.
NB: currently citerus has been tested on macOS and GNU/Linux only. Feel free to try it on Windows too though.
# Ack
Thanks to Mahak P. for coming up with the specific form of the citerus name.
Raw data
{
"_id": null,
"home_page": "https://github.com/matteocam/citerus",
"name": "citerus",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "citations,bibliography,latex",
"author": "Matteo Campanelli",
"author_email": "matteo.campanelli@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/dc/48/b8d5f4548dfe998157fbbb5434f51fc6d1e55a38967298d6eeb8c8aef582/citerus-0.1.0.tar.gz",
"platform": null,
"description": "# citerus\nA command-line tool to easily find cryptographic citations to use with LaTeX.\n\n .-.\n / .\\\n .' . .'.\n .-'. . . '-._\n .' .. . . . . '.\n /. . . . .\\\n / . . . . .. . . \\\n |. . . .. . . ... |\n / . . . . . .\\\n | . . ._______ .. . . . ..|\n | . / \\ . . . . |\n |. . { CITERUS }. .. . ..|\n |. . \\_______/. . ..|\n | . . . . . . . |\n |. . . .. . . ..|\n \\ . . . . . . . /\n | . . . . . . . |\n \\. . . . . .. . .'\n \\ .. .. . . /\n ':_ . . . ... _.'\n '-.. . . .-'\n '._..'\n\n\n\n# What does Citerus do?\n\nCiterus retrieves your citations. \n\n(_How do I pronounce it?_ Like so: /sa\u026at.r\u0259s/)\n\nWhen writing cryptographic papers, authors often use the excellent [cryptobib](https://cryptobib.di.ens.fr/) database. Since it consists of a large file, it is not often convenient to search in it. If you like the command line but you find grep awkward then citerus might be for you.\n\n**Example:** \nSuppose you want to find relevant citations for _round complexity in MPC_, just:\n- Type `citerus mpc round` in your terminal\n- Select all the papers that you find relevant (see screenshot). Exit the program.\n\nCiterus will automatically copy in your clipboard the relevant LaTeX code to cite them.\nThat's it!\n\n![Screenshot of citerus in action]([http://url/to/img.png](https://drive.google.com/file/d/1hNcfJLHTg_axQmjc4V1GyQ4ED7TCFdMs/view?usp=sharing))\n\nTo see more options and examples type `citerus --help`.\n\n\n# Installing\n`pip install citerus`\n\nIf you don't have pip, install it first with `python -m ensurepip --upgrade`.\n\nNB: currently citerus has been tested on macOS and GNU/Linux only. Feel free to try it on Windows too though.\n\n\n# Ack\nThanks to Mahak P. for coming up with the specific form of the citerus name.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "citerus retrieves your crypto citations",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/matteocam/citerus"
},
"split_keywords": [
"citations",
"bibliography",
"latex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6be7dab66384b1e123da8e659668f8c6d720b00bb62199c7bd703aeba1756da5",
"md5": "8f01202d06f22e53ec6b16ffd3369586",
"sha256": "cc390c8a1b9e31de942cc800cb010e46912b53325f2b693229758c47f1a61032"
},
"downloads": -1,
"filename": "citerus-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f01202d06f22e53ec6b16ffd3369586",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9089,
"upload_time": "2024-01-25T13:27:35",
"upload_time_iso_8601": "2024-01-25T13:27:35.419766Z",
"url": "https://files.pythonhosted.org/packages/6b/e7/dab66384b1e123da8e659668f8c6d720b00bb62199c7bd703aeba1756da5/citerus-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc48b8d5f4548dfe998157fbbb5434f51fc6d1e55a38967298d6eeb8c8aef582",
"md5": "efbd2511e16853771ce8faf601bcc510",
"sha256": "b1e963782c57ae06a9a0aa2532829e14b78b807bac07ab5631dd260974d0dc5e"
},
"downloads": -1,
"filename": "citerus-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "efbd2511e16853771ce8faf601bcc510",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8449,
"upload_time": "2024-01-25T13:27:37",
"upload_time_iso_8601": "2024-01-25T13:27:37.326594Z",
"url": "https://files.pythonhosted.org/packages/dc/48/b8d5f4548dfe998157fbbb5434f51fc6d1e55a38967298d6eeb8c8aef582/citerus-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 13:27:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matteocam",
"github_project": "citerus",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "citerus"
}