Welcome to amarium’s documentation!

You made it to the Amarium. Amarium is a library that handles tested and secure file operations for developers. If you need to work with local files reliably, amarium is the way!

Make sure to check out reference for information about our functions. The naming is quite intuitive and should be clear by just looking at the inputs and outputs.

If you have further questions, please let us know. The project lives from feedback, so feel free to give it.

Package Tree

• src.amarium package
  • Submodules
  • src.amarium.checks module
    • check_delete_dir()
    • check_header_and_data()
    • check_make_dir()
    • check_make_file_name_suffix()
    • check_make_subdirs()
  • src.amarium.csv_utils module
  • src.amarium.encryption module
    • decrypt_file()
    • encrypt_file()
    • generate_asymmetric_keys()
  • src.amarium.utils module
    • attach_slash()
    • b64encode_string()
    • combine_dirs()
    • convert_str_to_bool()
    • copy_dir()
    • copy_file()
    • delete_all_files_in_dir()
    • delete_empty_dir()
    • delete_file()
    • insert_string_in_file_name()
    • load_json_from_file()
    • make_date_file_name()
    • make_full_filename()
    • prepare_file_name_saving()
    • read_file()
    • remove_all_files_from_dir()
    • save_json_to_file()
    • search_subdirs()
    • write_file()
    • write_list_to_file()
    • write_tar()
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page