Skip to content
This repository has been archived by the owner on May 9, 2023. It is now read-only.

Commit

Permalink
Release v2.0.2 (#445)
Browse files Browse the repository at this point in the history
* Increasing code coverage by adding extra unit tests (#444)

* First batch of tests

* Added API tests, continued on file based tests

* Got 50% test coverage - needs to be addressed further

* update for README.md

* Formatting with black and version bump

* Passing the mypy check

* extra linting, formatting
  • Loading branch information
ShahriyarR authored May 6, 2021
1 parent 73fae15 commit cde176b
Show file tree
Hide file tree
Showing 12 changed files with 376 additions and 133 deletions.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,41 @@ backups. Then I decided to automate this process. In other words,
preparing necessary commands for backup and prepare stage were
automated.

We have nice CLI with necessary options:

```
autoxtrabackup --help
Usage: autoxtrabackup [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.
```


If you think, CLI is not for you. We have experimental feature where you can start API server
and take backups using API call.
and take backups using API call(ATTENTION: FastAPI involved)

```
sudo `which autoxtrabackup` --run-server
Expand All @@ -46,6 +79,7 @@ Development:

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.
Do you have an idea, question please open an issue.

Read full documentation here:
----------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import sphinx_rtd_theme
from mysql_autoxtrabackup.utils.version import VERSION

from mysql_autoxtrabackup.utils.version import VERSION

sys.path.insert(0, os.path.abspath("../mysql_autoxtrabackup"))

Expand Down
Loading

0 comments on commit cde176b

Please sign in to comment.