v2.0.1 (#439)

* Added new --run-server argument; it will fire up the API server (#437)

* Added new version.py file for just a placeholder for getting the exact version from one place (#440)

* Added new version.py file for just a placeholder for getting the exact version from one place

* getting the version from version.py for the FastAPI doc

* Added changes handler for each release (#442)

* Added changes handler for each release

* added changes file for this branch

* Added new change files

* Documentation updates

* Documentation updates extra

* Prepared the HISTORY.md

Author: ShahriyarR

HISTORY.md

@@ -0,0 +1,5 @@
+## v2.0.1 (2021-05-05)
+
+* Added change handler for each release(so-called HISTORY.md), #442 by @shahriyarr
+* Added new version.py file for getting the exact version from one place, #440 by @shahriyarr
+* New option --run-server was added to start API server, #437 by @shahriyarr

README.md

@@ -2,19 +2,52 @@ MySQL-AutoXtrabackup
 ====================
 
 MySQL AutoXtrabackup commandline tool written in Python 3.
-The source code fully typed with hints - structured the project mostly similar to awesome [FastAPI](https://fastapi.tiangolo.com/) 
+The source code fully typed with hints - structured the project mostly similar to
+[FastAPI](https://fastapi.tiangolo.com/) and [Pydantic](https://github.com/samuelcolvin/pydantic)
 
 For community from Azerbaijan MySQL User Community: [Python Azerbaijan Community](https://www.facebook.com/groups/python.az).
 
 For any question please open an issue here.
 
+What this project is about?
+---------------------------
+
+The idea for this tool, came from my hard times after accidentally
+deleting the table data.
+There was a full backup and 12 incremental backups.
+It took me 20 minutes to prepare necessary commands for preparing
+backups. If you have compressed + encrypted backups you need also,
+decrypt and decompress, which is going to add extra time for preparing
+backups. Then I decided to automate this process. In other words,
+preparing necessary commands for backup and prepare stage were
+automated.
+
+If you think, CLI is not for you. We have experimental feature where you can start API server 
+and take backups using API call.
+
+```
+sudo `which autoxtrabackup` --run-server
+INFO:     Started server process [30238]
+INFO:     Waiting for application startup.
+app started
+INFO:     Application startup complete.
+INFO:     Uvicorn running on http://127.0.0.1:5555 (Press CTRL+C to quit)
+```
+
+```
+$ curl -X POST http://127.0.0.1:5555/backup
+{"result":"Successfully finished the backup process"}
+```
+
+For the rest please read the full documentation.
+
 Development:
 -------------------
 
-Current major version is 2.0 - so if you want to help, please do changes on this branch and then kindly send PR :)
+Current major version is >= 2.0 - so if you want to help, please do changes on this branch and then kindly send PR :)
 I also encourage you to upgrade from older version as the code base fully updated.
 
-Read full documentation here(can be outdated):
+Read full documentation here:
 ----------------------------------------------
 
 [**MySQL-AutoXtrabackup documentation!**](https://autoxtrabackup.azepug.az/)

changes/README.md

@@ -0,0 +1,8 @@
+# Pending Changes
+
+This directory contains files describing changes to `mysql-autoxtrabackup` since the last release.
+
+If you're creating a pull request, please add a new file to this directory called
+`<pull request or issue id>-<github username>.md`. It should be formatted as a single paragraph of markdown
+
+The contents of this file will be used to update `HISTORY.md` before the next release.

changes/make_history.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+import re
+import sys
+from datetime import date
+from importlib.machinery import SourceFileLoader
+from pathlib import Path
+
+THIS_DIR = Path(__file__).parent
+name_regex = re.compile(r'(\d+)-(.*?)\.md')
+bullet_list = []
+
+for p in THIS_DIR.glob('*.md'):
+    if p.name == 'README.md':
+        continue
+    m = name_regex.fullmatch(p.name)
+    if not m:
+        raise RuntimeError(f'{p.name!r}: invalid change file name')
+    gh_id, creator = m.groups()
+    content = p.read_text().replace('\r\n', '\n').strip('\n. ')
+    if '\n\n' in content:
+        raise RuntimeError(f'{p.name!r}: content includes multiple paragraphs')
+    content = content.replace('\n', '\n  ')
+    priority = 0
+    if '**breaking change' in content.lower():
+        priority = 2
+    elif content.startswith('**'):
+        priority = 1
+    bullet_list.append((priority, int(gh_id), f'* {content}, #{gh_id} by @{creator}'))
+
+if not bullet_list:
+    print('no changes found')
+    sys.exit(0)
+
+version = SourceFileLoader('version', 'mysql_autoxtrabackup/utils/version.py').load_module()
+chunk_title = f'v{version.VERSION} ({date.today():%Y-%m-%d})'
+new_chunk = '## {}\n\n{}\n\n'.format(chunk_title, '\n'.join(c for *_, c in sorted(bullet_list, reverse=True)))
+
+print(f'{chunk_title}...{len(bullet_list)} items')
+history_path = THIS_DIR / '..' / 'HISTORY.md'
+history = new_chunk + history_path.read_text()
+
+history_path.write_text(history)
+for p in THIS_DIR.glob('*.md'):
+    if p.name != 'README.md':
+        p.unlink()
+
+print(
+    'changes deleted and HISTORY.md successfully updated, to reset use:\n\n'
+    '  git checkout -- changes/*-*.md HISTORY.md\n'
+)

docs/advance_features.rst

@@ -111,7 +111,7 @@ Taking backup:
 ::
 
 
-        $ autoxtrabackup -v -lf /home/shahriyar.rzaev/autoxtrabackup_2_3_5_6.log -l DEBUG \
+        $ sudo autoxtrabackup -v -lf /home/shahriyar.rzaev/autoxtrabackup_2_3_5_6.log -l DEBUG \
         --defaults-file=/home/shahriyar.rzaev/XB_TEST/server_dir/xb_2_4_ps_5_7.cnf --backup --dry_run
 
 
@@ -120,7 +120,7 @@ Preparing backups:
 ::
 
 
-        $ autoxtrabackup -v -lf /home/shahriyar.rzaev/autoxtrabackup_2_3_5_6.log -l DEBUG \
+        $ sudo autoxtrabackup -v -lf /home/shahriyar.rzaev/autoxtrabackup_2_3_5_6.log -l DEBUG \
         --defaults-file=/home/shahriyar.rzaev/XB_TEST/server_dir/xb_2_4_ps_5_7.cnf --prepare --dry_run
 
 

docs/api.rst

@@ -0,0 +1,50 @@
+Here is the basic ideas how to use API calls to operate on backups
+==================================================================
+
+Currently, we have only 4 endpoints.
+
+.. image:: doc_api.png
+   :width: 400
+   :alt: DOC API
+
+
+Sample cURLs:
+-------------
+
+After starting API server:
+
+::
+
+    $ sudo `which autoxtrabackup` --run-server
+
+Of course you can use the Web UI for taking backups, but in case you want to send requests,
+below I have provided sample cURLs.
+
+Taking backup:
+
+::
+
+    $ curl -X POST http://127.0.0.1:5555/backup
+    {"result":"Successfully finished the backup process"}
+
+Preparing backup:
+
+::
+
+    $ curl -X POST http://127.0.0.1:5555/prepare
+    {"result":"Successfully prepared all the backups"}
+
+Listing backups:
+
+::
+
+    $ curl http://127.0.0.1:5555/backups
+    {"backups":{"full":[{"2021-05-05_18-37-36":"Full-Prepared"}],"inc":["2021-05-05_18-38-19"]}}
+
+
+Removing backups:
+
+::
+
+    $ curl -X DELETE http://127.0.0.1:5555/delete
+    {"result":"There is no backups or backups removed successfully"}

docs/basic_features.rst

@@ -6,7 +6,7 @@ Backup
 
 Yes you are right, this tool is for taking backups.
 It should take care for automating this process for you.
-You can specify the backup directory in config file (default /etc/bck.conf) under [Backup] category.
+You can specify the backup directory in config file (default  ~/.autoxtrabackup/autoxtrabackup.cnf) under [Backup] category.
 So you have prepared your config and now you are ready for start.
 
 The command for taking full backup with DEBUG enabled, i.e first run of the tool.
@@ -81,7 +81,7 @@ For now let's choose 1:
 
 ::
 
-    $ sudo /home/shako/REPOS/MySQL-AutoXtraBackup/.venv/bin/autoxtrabackup --prepare -v -l DEBUG
+    $ sudo `which autoxtrabackup` --prepare -v -l DEBUG
 
 
 That's it. Your backup is ready to restore/recovery.

docs/basic_overview.rst

@@ -10,15 +10,15 @@ backups, also for preparing backups, as well as to restore. Here is project path
 
 ::
 
-    * backup_backup  -- Full and Incremental backup taker script.
-    * backup_prepare        -- Backup prepare and restore script.
-    * general_conf          -- All-in-one config file's and config reader class folder.
-    * process_runner        -- The directory for process runner script.
-    * test                  -- The directory for test things.
-    * setup.py              -- Setuptools Setup file.
-    * autoxtrabackup.py     -- Commandline Tool provider script.
-    * VagrantFile           -- The Vagrant thing for starting using this tool[will be useful to contributors].
-    * ~/.autoxtrabackup/autoxtrabackup.cnf        -- Config file will be created during setup.
+    * mysql_autoxtrabackup                       -- source directory
+    * mysql_autoxtrabackup/backup_backup         -- Full and Incremental backup taker script.
+    * mysql_autoxtrabackup/backup_prepare        -- Backup prepare and restore script.
+    * mysql_autoxtrabackup/general_conf          -- All-in-one config file's and config reader class folder.
+    * mysql_autoxtrabackup/process_runner        -- The directory for process runner script.
+    * mysql_autoxtrabackup/autoxtrabackup.py     -- Commandline Tool provider script.
+    * mysql_autoxtrabackup/api                   -- The API server written in FastAPI.
+    * tests                                      -- The directory for test things.
+    * ~/.autoxtrabackup/autoxtrabackup.cnf       -- Config file will be created during setup.
 
 
 Available Options
@@ -32,20 +32,24 @@ Available Options
     Options:
       --dry-run                       Enable the dry run.
       --prepare                       Prepare/recover backups.
+      --run-server                    Start the FastAPI app for serving API
       --backup                        Take full and incremental backups.
       --version                       Version information.
       --defaults-file TEXT            Read options from the given file  [default: /
                                       home/shako/.autoxtrabackup/autoxtrabackup.cn
                                       f]
+
       --tag TEXT                      Pass the tag string for each backup
       --show-tags                     Show backup tags and exit
       -v, --verbose                   Be verbose (print to console)
       -lf, --log-file TEXT            Set log file  [default: /home/shako/.autoxtr
                                       abackup/autoxtrabackup.log]
+
       -l, --log, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                       Set log level  [default: INFO]
       --log-file-max-bytes INTEGER    Set log file max size in bytes  [default:
                                       1073741824]
+
       --log-file-backup-count INTEGER
                                       Set log file backup count  [default: 7]
       --help                          Print help message and exit.