Example.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "9125279f-7d61-46f0-a117-90a71b0eb1f5",
   "metadata": {},
   "outputs": [],
   "source": [
    "import autobkp as abk    # replace this with the correct import name"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "477243d8-2152-4ccf-9929-8ba89d4ae812",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "abk.__version__ = '1.0.1'\n",
      "\n",
      "Help on function backup in module autobkp.autobkp:\n",
      "\n",
      "backup(src_path: str, dst_path: str, src_filename: None | str = None, filecmp_shallow: bool = True, gztar_list: set[str] | list[str] = {'.git'}, ignore_list: set[str] | list[str] = {'__pycache__', '.ipynb_checkpoints'}, dry_run: bool = False, log_lvl: bool | int = 10, verbose: int = 4) -> dict\n",
      "    Backup data from src to dst.\n",
      "\n",
      "    New backup function!\n",
      "\n",
      "    WARNING: SYMBOLIC LINKS WON'T BE FOLLOWED.\n",
      "    WARNING: DO NOT HAVE FILES HAVING THE SAME NAME WITH THE DIRECTORIES- WILL CAUSE CONFUSION FOR THE CODE\n",
      "    WARNING: DO NOT PUT DESTINATION PATH dst_path IN ANY SUBFOLDER OF src_path- MAY CAUSE CATASTROPHIC CONSEQUENCES.\n",
      "\n",
      "\n",
      "    Parameters\n",
      "    ----------\n",
      "    src_path: str\n",
      "        Path to the source files. Could point to one file or one directory.\n",
      "\n",
      "    dst_path: str\n",
      "        Path to the backup destination where files will be stored. Could point to one file or one directory.\n",
      "\n",
      "    src_filename: str\n",
      "        File name of the source file / folder\n",
      "        i.e. if src_path == \"/home/admin/abc/edf/\", then src_filename would be \"edf\"\n",
      "        If None, will infer from src_path\n",
      "        if src_path == \"../..\", then src_filename would be inferred to be \"..\"\n",
      "            in which case, you might want to manually set it to be whatever you prefer\n",
      "\n",
      "    filecmp_shallow: bool\n",
      "        If True, will not compare src files and dst files (if exist) byte by byte;\n",
      "            They will be considered true if they have the same size and modification time.\n",
      "\n",
      "    gztar_list: list\n",
      "        make an archive for folder names matching this list.\n",
      "\n",
      "    ignore_list: list\n",
      "        Do not backup files/folders within this list at all.\n",
      "        Only check this if src_path points to a folder.\n",
      "\n",
      "    dry_run: bool\n",
      "        Print what will be done (if verbose >= 3) instead of actually doing.\n",
      "\n",
      "    log_lvl : bool|int\n",
      "        If true, will auto log to files.\n",
      "\n",
      "    verbose: int\n",
      "        Wehther errors, warnings, notes, and debug info should be printed on screen.\n",
      "\n",
      "    Returns\n",
      "    -------\n",
      "    filetree: dict\n",
      "        See get_filetree() for format.\n",
      "\n"
     ]
    }
   ],
   "source": [
    "if __name__ == '__main__':\n",
    "    # print info\n",
    "    print(f\"{abk.__version__ = }\\n\")\n",
    "    help(abk.backup)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "68d7de7b-3119-44fc-8b2f-8945738ce910",
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tLogging to '/mnt/d/da/temp/temp_backup/_bkp_meta_/test_example.filetree.bkp20240913024219544760.log',\n",
      "\tunder __name__='autobkp.autobkp'.\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\t\n",
      "\n",
      "\n",
      "\tBeginning backup (dry_run=False)\n",
      "\t\n",
      "\n",
      "\tsrc_path='autobkp'\n",
      "\tdst_filepath='/mnt/d/da/temp/temp_backup/test_example'\n",
      "\t\n",
      "\n",
      "\tStart: 2024-09-13T02:42:19.571205+00:00\n",
      "\t\n",
      "\n",
      "\tScanning file tree...\t\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tScanned 8 files.\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tWriting file tree data to '/mnt/d/da/temp/temp_backup/_bkp_meta_/test_example.filetree.bkp20240913024219544760.json'\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tReading file tree data from '/mnt/d/da/temp/temp_backup/_bkp_meta_/test_example.filetree.json'\n",
      "\tNote that you can delete that file to force the code to re-backup everything.\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tRead old filetree data from '/mnt/d/da/temp/temp_backup/_bkp_meta_/test_example.filetree.json'.\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tFiletree read complete.\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\t\n",
      "\n",
      "\tNow  : 2024-09-13T02:42:19.637710+00:00\n",
      "\tTime Used: 0:00:00.066505\n",
      "\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\t\n",
      "\n",
      "\tBeginning backup...\n",
      "\n",
      "\n",
      "*   Note   :    backup() ==> _backup_sub() ==> _save_bkp_file():\n",
      "\tgzip-ing 'autobkp/autobkp.py' to '/mnt/d/da/temp/temp_backup/test_example/autobkp.py.bkp20240801034935720927._bkp_.gz'\n",
      "*   Note   :    <module>() ==> backup() ==> _backup_sub():\n",
      "\tCreating Directory '/mnt/d/da/temp/temp_backup/test_example/io'\n",
      "*   Note   :    _backup_sub() ==> _backup_sub() ==> _save_bkp_file():\n",
      "\tgzip-ing 'autobkp/io/json.py' to '/mnt/d/da/temp/temp_backup/test_example/io/json.py.bkp20240510080823794555._bkp_.gz'\n",
      "*   Note   :    _backup_sub() ==> _backup_sub() ==> _save_bkp_file():\n",
      "\tgzip-ing 'autobkp/io/_shared.py' to '/mnt/d/da/temp/temp_backup/test_example/io/_shared.py.bkp20240510074024396408._bkp_.gz'\n",
      "*   Note   :    _backup_sub() ==> _backup_sub() ==> _save_bkp_file():\n",
      "\tgzip-ing 'autobkp/io/__init__.py' to '/mnt/d/da/temp/temp_backup/test_example/io/__init__.py.bkp20240510080604312174._bkp_.gz'\n",
      "*   Note   :    backup() ==> _backup_sub() ==> _save_bkp_file():\n",
      "\tgzip-ing 'autobkp/log.py' to '/mnt/d/da/temp/temp_backup/test_example/log.py.bkp20240503032015172310._bkp_.gz'\n",
      "*   Note   :    backup() ==> _backup_sub() ==> _save_bkp_file():\n",
      "\tgzip-ing 'autobkp/__init__.py' to '/mnt/d/da/temp/temp_backup/test_example/__init__.py.bkp20240801035001436110._bkp_.gz'\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\t\n",
      "\n",
      "\tSkipped  0 files,\n",
      "\tCopied   6 files,\n",
      "\tArchived 0 directories,\n",
      "\tEntered  2 directories,\n",
      "\tTotally processed 8  / 8 files.\n",
      "\t\n",
      "\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\tOverwriting file tree data from '/mnt/d/da/temp/temp_backup/_bkp_meta_/test_example.filetree.bkp20240913024219544760.json' to '/mnt/d/da/temp/temp_backup/_bkp_meta_/test_example.filetree.json'\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\t\n",
      "\n",
      "\tEnded: 2024-09-13T02:42:19.732580+00:00\n",
      "\tTime Used: 0:00:00.161375\n",
      "\n",
      "*   Note   :    run_code() ==> <module>() ==> backup():\n",
      "\t\n",
      "\n",
      "\n",
      "\t\t--- All done ---\n",
      "\n",
      "\n",
      "\n"
     ]
    }
   ],
   "source": [
    "if __name__ == '__main__':\n",
    "    # this function will create two additional files in {dst_path}/_bkp_meta_ dir, as well as copying everying if dry_run=False:\n",
    "    #     a .json file recording every file in the directory, and\n",
    "    #     a .log  file recording the files\n",
    "    # new_filetree is the content in the filetree\n",
    "    new_filetree = abk.backup(\n",
    "        src_path='./autobkp',    # replace this with the path to your directory that you want to be backed-up\n",
    "        dst_path='/mnt/d/da/temp/temp_backup',    # replace this with the path to the place where you want your files to be copied to\n",
    "        src_filename=\"test_example\",    # name of the backup operation. Set it to wahtever you like.\n",
    "        dry_run=False,    # if True, will not do the actual copying.\n",
    "    )"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "a5881822-04f0-4ea6-a8af-47d0b33aff60",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.12.4"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}