Metadata-Version: 2.1
Name: citerus
Version: 0.1.0
Summary: citerus retrieves your crypto citations
Home-page: https://github.com/matteocam/citerus
Author: Matteo Campanelli
Author-email: matteo.campanelli@gmail.com
License: MIT License
Keywords: citations,bibliography,latex
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual >=0.45.0
Requires-Dist: rich >=13.7.0
Requires-Dist: GitPython >=3.1.41
Requires-Dist: pyperclip

# 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.
