Skip to content

Commit

Permalink
Merge branch 'release_0.4.0-beta.2' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
melchor629 committed Nov 2, 2019
2 parents c20d0f0 + 1c3c2cd commit 866a90c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/MajorcaDevs/mdbackup.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MajorcaDevs/mdbackup/context:python)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/MajorcaDevs/mdbackup.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MajorcaDevs/mdbackup/alerts/)
[![Build Status](https://jenkins.majorcadevs.com/buildStatus/icon?job=mdbackup2%2Fmaster&subject=master%20build)](https://jenkins.majorcadevs.com/job/mdbackup2/job/master/)
[![Build Status](https://jenkins.majorcadevs.com/buildStatus/icon?job=mdbackup2%2Fdev&subject=dev%20build)](https://jenkins.majorcadevs.com/job/mdbackup2/job/dev/)

Small but customizable utility to create backups and store them in cloud storage providers.

Expand All @@ -12,9 +14,7 @@ Download from releases the latest `wheel` package and install it. It is recommen
**What do yo need?**:

- An OS different from Windows (Windows is unsupported) :(
- Python 3.6 or higher
- `rsync` and `ssh` installed (on macOS they are in general installed by default, on Linux distros you may need to install them)
- `bash` must be installed, used to run the scripts
- Python 3.7 or higher

First select a folder where all the needed files will be stored. It is important not to move (or rename) this folder after installation.

Expand All @@ -34,12 +34,12 @@ pip install --upgrade setuptools wheel
pip install mdbackup*.whl
```

Now you can run the utility (only if you have enabled the virtual env) with `mdbackup`. In this folder it is recommended to store the `config` and `steps` folders.
Now you can run the utility (only if you have enabled the virtual env) with `mdbackup`. In this folder it is recommended to store the `config` folder.

> **Note:** to be able to use some of the cloud storage and secrets backends, you will be requested to install some packages. Go to the documentation to see what is needed.
## Documentation

Can be found at docs folder.
Can be found at [mdbackup.majorcadevs.com](https://mdbackup.majorcadevs.com/) or at the docs folder.

To make the documentation, install the requirements in `docs/requirements.txt` and run `mkdocs build --config-file=mkdocs.yaml`.
6 changes: 5 additions & 1 deletion mdbackup/actions/builtin/_os_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
from pathlib import Path
from threading import Thread

import xattr
try:
import xattr
except ImportError:
xattr = None


# Portable way to access to these xattr function across linux, macOS, freebsd...
_python_has_xattr_lib = hasattr(os, 'listxattr') and hasattr(os, 'getxattr') and hasattr(os, 'setxattr')
Expand Down
10 changes: 8 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
import sys

import setuptools

with open("README.md", "r") as fh:
long_description = fh.read()

extra_packages = []
if not sys.platform.startswith('linux'):
extra_packages.append('xattr')

setuptools.setup(
name="mdbackup",
version="0.4.0-beta.1",
version="0.4.0-beta.2",
author="majorcadevs (melchor9000 & amgxv)",
author_email="melchor9000@gmail.com",
description="Small but customizable utility to create backups and store them in cloud storage providers",
Expand Down Expand Up @@ -33,7 +39,7 @@
include_package_data=True,
install_requires=[
'pyyaml',
'xattr',
'jsonschema',
*extra_packages,
],
)

0 comments on commit 866a90c

Please sign in to comment.