Skip to content

Commit

Permalink
Improve metadata of setup.py for packaging (#198)
Browse files Browse the repository at this point in the history
- improve description/summary
- add long_description, keywords, classifiers, license, download_url, platforms
- fix small repetition in readme
  • Loading branch information
ericzolf committed Dec 1, 2019
1 parent 96e5b5a commit 6584aa8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -9,7 +9,7 @@ Users have reported using it successfully on FreeBSD and MacOS X.
Beside it's ease of use, one of the main advantages of rdiff-backup is that it
does use the same efficient protocol as rsync to transfer and store data.
Because rdiff-backup only stores the differences from the previous backup to
the latest one (a so called
the next one (a so called
[reverse incremental backup](https://en.wikipedia.org/wiki/Incremental_backup#Reverse_incremental)),
the latest backup is always a full backup, making it easiest
and fastest to restore the most recent backups, combining the space
Expand Down
37 changes: 36 additions & 1 deletion setup.py
Expand Up @@ -131,11 +131,46 @@ def run(self):
setup(
name="rdiff-backup",
use_scm_version=True,
description="Local/remote mirroring+incremental backup",
description="Backup and Restore utility, easy to use, efficient, locally and remotely usable",
long_description="""
rdiff-backup is a simple backup tool which can be used locally and remotely,
on Linux and Windows, and even cross-platform between both.
Users have reported using it successfully on FreeBSD and MacOS X.
Beside it's ease of use, one of the main advantages of rdiff-backup is that it
does use the same efficient protocol as rsync to transfer and store data.
Because rdiff-backup only stores the differences from the previous backup to
the next one (a so called reverse incremental backup),
the latest backup is always a full backup, making it easiest
and fastest to restore the most recent backups, combining the space
advantages of incremental backups while keeping the speed advantages of full
backups (at least for recent ones).
If the optional dependencies pylibacl and pyxattr are installed,
rdiff-backup will support Access Control Lists and Extended Attributes
provided the file system(s) also support these features.""",
keywords=['backup', 'simple', 'easy', 'remote', 'incremental', 'efficient', 'cross-platform'],
classifiers=[
'Development Status :: 4 - Beta',
'Environment :: Console',
'Intended Audience :: End Users/Desktop',
'Intended Audience :: System Administrators',
'License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)',
'Natural Language :: English',
'Operating System :: POSIX :: Linux',
'Operating System :: POSIX', # generic because users reported FreeBSD to work
'Operating System :: Microsoft :: Windows',
'Programming Language :: Python :: 3',
'Topic :: System :: Archiving :: Backup',
],
license="GPLv2+",
author="The rdiff-backup project",
author_email="rdiff-backup-users@nongnu.org",
# maintainer and maintainer_email could be used to differentiate the package owner
url="https://rdiff-backup.net/",
download_url="https://github.com/rdiff-backup/rdiff-backup/releases",
python_requires='~=3.5',
platforms=['linux', 'win32'],
packages=["rdiff_backup"],
package_dir={"": "src"}, # tell distutils packages are under src
ext_modules=[
Expand Down

0 comments on commit 6584aa8

Please sign in to comment.