Merge pull request #6 from needs-coffee/dev

Version bump to 0.2

.github/workflows/test-package.yaml

@@ -7,7 +7,7 @@ on:
   push:
     branches: [ main, dev ]
   pull_request:
-    branches: [ main ]
+    branches: [ main, dev ]
 
 jobs:
   test:

.gitignore

@@ -123,7 +123,7 @@ celerybeat.pid
 
 # Environments
 .env
-.venv
+.venv*
 env/
 venv/
 ENV/

CHANGELOG.md

@@ -5,6 +5,31 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## 0.2.0-beta - 25-06-2022
+### Added 
+- Autoconfirm CLI flag (-y/--autoconfirm)
+- Add option for all targets at cli (-a/--all)
+- detect if platform is not windows and quit. Only functions on windows. 
+- option to Tar before 7z for all targets
+- Warning added for short password length with interactive config
+- Keys missing in config file are filled with default values
+### Changed
+- upgrade 7z from version 19 to version 22 (~20% speed increase)
+- Plex dedicated functions removed, backed up as a standard folder
+- check plex database size correctly and decide on splitting - don't always force splitting.
+- Refactoring of backup functions.
+- Removed split-force config option
+### Fixed
+- Fix performance bug if compression level = 0 (store) (remove md + m0 cli flags)
+
+
+## 0.1.7-beta
+### Fixed 
+- Fix for virtualbox config
+### Added
+- GH CI/CD
+
+
 ## 0.1.0-beta - 03-05-2022
 ### Added
--Initial Release
+- Initial Release

README.md

@@ -4,7 +4,8 @@
 
 A python package to back up user files on Windows to 7z archives. Useful for offsite or cloud backups and backups can be optionally encrypted with AES256. Archives can be Optionally split archives into smaller archives for easier management. As well as user files can backup Plex Media Server, Hyper-V Virtual Machines and VirtualBox Virtual Machines.
 
-- embeds 7za to perform compression
+- embeds 7z to perform compression
+- saves lists of installed programs and drivers
 - optional AES256 encryption
 - Archives produced are full backups - no incremental backups at present
 - Archives saved in the format - host_user_yyyy-mm-dd_folder.7z
@@ -33,6 +34,22 @@ or ```winbackup --create-configfile```. This config file must be modified before
 
 To generate a configuration file interactively run ```winbackup -i``` or ```winbackup --interactive-config```. This file can be run without modification for later use.
 
+Full CLI options
+----------------
+
+Available CLI options.
+
+Flag | Option                | Desc                                                              |
+-----|-----------------------|-------------------------------------------------------------------|
+`-a` | `--all`               | Run backup with all possible backup targets selected              |
+`-c` | `--configfile`        | Run backup from a supplied yaml config file                       |
+`-C` | `--create-configfile` | Create a default configuration file template. Will need modified before being run.
+`-h` | `--help`              | Displays help information
+`-i` | `--interactive-config`| Generate a configuration file interactively, can be run directly after generation 
+`-q` | `--quiet`             | Minimal terminal output                                           |
+`-v` | `--verbose`           | Sets logging to debug. Only affects log file not stdout.          |
+`-V` | `--version`           | Print version info.                                               |
+`-y` | `--autoconfirm`       | Autoconfirm prompts                                               |
 Tests
 -----
 To run unitests

pyproject.toml

@@ -3,4 +3,9 @@ requires = [
     "setuptools>=42",
     "wheel"
 ]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 95
+target-version = ['py37']
+include = '\.pyi?$'

requirements.dev.txt

@@ -0,0 +1,8 @@
+colorama>=0.4.4
+Send2Trash>=1.8.0
+tqdm>=4.63.0
+humanize>=4.0.0
+PyYAML>=6.0
+black>=22
+flake8>=4.0
+build>=0.8

setup.cfg

@@ -35,3 +35,8 @@ winbackup = scripts/*, bin/7z/*
 console_scripts = 
     winbackup = winbackup.__main__:cli
 
+[flake8]
+extend-ignore = E203, E266, W503, E501
+max-line-length = 95
+max-complexity = 25
+select = B,C,E,F,W,T4,B9,B950

setup.py

@@ -2,5 +2,5 @@
 
 import setuptools
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     setuptools.setup()  # see setup.cfg