Main#
Main CLI module.
- crypto_condor.cli.main.method(primitive, out=None)#
Command to get a method guide in Markdown.
- Parameters:
primitive (str) – The method guide to get.
out (Path | None) – Where to save the guide.
- crypto_condor.cli.main.list_command()#
List the currently supported primitives.
- crypto_condor.cli.main.wrap(
- primitive,
- directory=None,
- language='',
- show_languages=False,
- force=False,
- wrapper_example=0,
Fetches a wrapper template.
- Parameters:
primitive (str) – The primitive to get a wrapper of.
directory (str | None) – Where to copy the template to, current working directory by default.
language (str) – The programming language of the wrapper.
show_languages (bool) – An option to display a list of primitives and the languages that have corresponding wrappers available. It’s an eager option that uses the
list_languages()
callback, so the argument is not used in the function itself.force (bool) – Whether to overwrite existing templates in the given directory.
wrapper_example (int) – Number of the example to get.
- crypto_condor.cli.main.testu01(file, bit_count=0, where=False, filename='', no_save=False)#
Tests the output of a PRNG using TestU01.
- Parameters:
file (Path) – The name of the file to use.
bit_count (int) – The number of bits to test. Must be less or equal to the actual size of the file.
where (bool) – Calls
crypto_condor.cli.callbacks.print_testu01_install_dir()
.filename (str) – Name of the file to save results.
no_save (bool) – Do not save results or prompt the user.
- crypto_condor.cli.main.main(verbose=0, version=False)#
Main function.
- Parameters:
verbose (int) – The level of verbosity. Typer counts the number of occurrences of ‘-v’ when using the CLI.
version (bool) – Displays the version and exits. It’s an eager option that uses the
print_version()
callback.