Skip to main content

citerus retrieves your crypto citations

Project description

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.

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.

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

citerus-0.1.0.tar.gz (8.4 kB view hashes)

Uploaded Source

Built Distribution

citerus-0.1.0-py3-none-any.whl (9.1 kB view hashes)

Uploaded Python 3

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