edoars / citerus

Citerus retrieves your cryptographic citations.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

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.

Citerus has been tested on macOS, GNU/Linux and Windows. Windows users may need to make sure that the installed citerus script is in PATH following some of the tips here.

Ack

Thanks to Mahak P. for coming up with the specific form of the citerus name.

About

Citerus retrieves your cryptographic citations.

License:MIT License


Languages

Language:Python 100.0%