All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Borg version bumped to 1.2.4
- Dotenv version bumped to 1.0.0 in "requirements.txt"
- Borg command
compact
- Borg version bumped to 1.2.3
- Dotenv version bumped to 1.0.0
- Dropped support for Python 3.6 and 3.7
- Added support for Python 3.11
- Default log level is "warning" instead of "info"
- Capturing json output uses Borgs JsonFormatter for the logger
- Log level is passed for each command so individual command calls can accurately refelct wanted
output, before if
log_json
was used, it ignored log level
- Mounting / Unmounting tests failing due to OS taking some time, added a longer sleep to prevent them from failing
fuse
in the optional install requirements was the incorrect name of the package, changed tollfuse
- Readme reflects acutally current return values for commands, had still referenced an old style
- Commands not returns a single value
- If multiple values are captured, a
dict
is returned with relevant key names - Single value is returned by itself
- No captured value returns
None
- If multiple values are captured, a
- Missing benchmark test added back in
- Type hint for command returns changed to custom type hint
BorgRunOutput
which is a tupleUnion[str, dict, None]
for stdout and stderr capture
change
changes
argument now positional magic variable. (*changes
)- Passing in strings to get the values returns a list
- Passing in tuples to set the values returns None
import
andexport
:- Appends
path
to end of args instead of trying to extend because only one path can be passed
- Appends
benchmark_crud
:- Command is now added as two seperate words instead of one
(
"benchmark crud"
->["benchmark", "crud"]
)
- Command is now added as two seperate words instead of one
(
ExclusionOptions
:pattern
now processed as a list
- Commands now return captured
stdout
andstderr
instead of juststdout
borg
removes the first value from the args list. The list being passed in started with the command name (eginit
,create
,list
) so that was getting removed. Addedborgapi
as the first argument for it to get removed when the command is called now.
- Borg commands
serve
,with-lock
,break-lock
, andbenchmark crud
asserve
,with_lock
,break_lock
, andbenchmark_crud
respectivly.
- Added missing options to the following commands:
- prune:
keep_last
- mount:
o
- prune:
- Added missing options to the following
Options
dataclasses:- CommonOptions:
debug_topic
- CommonOptions:
- Added
python-dotenv
to the Installation section in the README - Add warning at top of README file saying how this is not how the borg developers intended use.
- Add roadmap items to the README
- Add
config
to the "Command Quirks" section of readme
__post_init__
was not being called by the__init__
function, moved logic from__post_init__
into__init__
- Loading environment variables using python-dotenv v0.17.1
- Info on how to set and unset environment variables
- Formated the README to have shorter line lenghts, no changes in display
- Removed the Roadmap item for loading environment variables
- Sample files to help with understanding different setttings
- Moved the
.env.sample
file into the sample folder with the other added sample files
- Links in the README to the PyPi project and Github repository
- Homepage url for the project from selfhosted Gitea site to github.
- License to MIT License from Anti-Capitalist Software License