borg/setup.cfg

[metadata]
name = borgbackup
author = The Borg Collective (see AUTHORS file)
description = Deduplicated, encrypted, authenticated and compressed backups
url = https://borgbackup.org
keywords =
  backup
  borgbackup
classifiers =
    Development Status :: 4 - Beta
    Environment :: Console
    Intended Audience :: System Administrators
    License :: OSI Approved :: BSD License
    Operating System :: POSIX :: BSD :: FreeBSD
    Operating System :: POSIX :: BSD :: OpenBSD
    Operating System :: POSIX :: BSD :: NetBSD
    Operating System :: MacOS :: MacOS X
    Operating System :: POSIX :: Linux
    Programming Language :: Python
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: 3.11
    Topic :: Security :: Cryptography
    Topic :: System :: Archiving :: Backup
platforms = Linux, MacOS X, FreeBSD, OpenBSD, NetBSD
license = BSD
license_files = LICENSE
project_urls =
    Bug Tracker = https://github.com/borgbackup/borg/issues
    Documentation = https://borgbackup.readthedocs.io
    Source Code = https://github.com/borgbackup/borg

[options]
packages = find_namespace:
package_dir =
    =src
python_requires = >=3.9
install_requires =
  msgpack >=1.0.3, <=1.0.5
  packaging
  platformdirs >=3.0.0, <4.0.0; sys_platform == 'darwin'  # for macOS: breaking changes in 3.0.0,
  platformdirs >=2.6.0, <4.0.0; sys_platform != 'darwin'  # for others: 2.6+ works consistently.
  argon2-cffi
tests_require =
  pytest
zip_safe = False
# See also the MANIFEST.in file.
# We want to install all the files in the package directories...
include_package_data = true

# ...except the source files which have been compiled (C extensions):
[options.exclude_package_data]
* =
    *.c
    *.h
    *.pyx

[options.packages.find]
where = src

[options.entry_points]
console_scripts =
    borg = borg.archiver:main
    borgfs = borg.archiver:main

[options.extras_require]
llfuse = llfuse >= 1.3.8
pyfuse3 = pyfuse3 >= 3.1.1
nofuse =

[tool:pytest]
python_files = testsuite/*.py
markers =
    allow_cache_wipe

[flake8]
# for reference ...
#   E402 module level import not at top
#   E501 line too long
#   F401 import unused
#   F405 undefined or defined from star imports
#   F811 redef of unused var
#   #### Pick either W503, or W504 - latest recommendation from pep8 is to ignore W503
#   W503 line break before binary operator
#   W504 line break after binary operator

# borg code style guidelines:
# Ignoring E203 due to https://github.com/PyCQA/pycodestyle/issues/373
ignore = W503, E203, F405, E402

# Code style violation exceptions:
# please note that the values are adjusted so that they do not cause failures
# with existing code. if you want to change them, you should first fix all
# flake8 failures that appear with your change.
per_file_ignores =
    src/borg/archive.py:E501
    src/borg/archiver/help_cmd.py:E501
    src/borg/cache.py:E501
    src/borg/helpers/__init__.py:F401
    src/borg/platform/__init__.py:F401
    src/borg/testsuite/archiver/disk_full.py:F811
    src/borg/testsuite/archiver/return_codes.py:F811
    src/borg/testsuite/benchmark.py:F811
    src/borg/testsuite/platform.py:F811

max_line_length = 120
exclude = build,dist,.git,.idea,.cache,.tox

[mypy]
python_version = 3.9
strict_optional = False
local_partial_types = True
show_error_codes = True
files = src/borg/**/*.py

[mypy-msgpack.*]
ignore_missing_imports = True
[mypy-llfuse]
ignore_missing_imports = True
[mypy-pyfuse3]
ignore_missing_imports = True
[mypy-trio]
ignore_missing_imports = True

[mypy-borg.crypto.low_level]
ignore_missing_imports = True
[mypy-borg.platform.*]
ignore_missing_imports = True
Initial commit 2022-03-23 11:19:18 +00:00			`[metadata]`
			`name = borgbackup`
			`author = The Borg Collective (see AUTHORS file)`
			`description = Deduplicated, encrypted, authenticated and compressed backups`
use borgbackup.org as main site the github site is linked via project_urls -> Source Code 2022-04-13 01:48:33 +00:00			`url = https://borgbackup.org`
Initial commit 2022-03-23 11:19:18 +00:00			`keywords =`
			`backup`
			`borgbackup`
			`classifiers =`
beta status now 2022-09-16 19:26:41 +00:00			`Development Status :: 4 - Beta`
Initial commit 2022-03-23 11:19:18 +00:00			`Environment :: Console`
			`Intended Audience :: System Administrators`
			`License :: OSI Approved :: BSD License`
			`Operating System :: POSIX :: BSD :: FreeBSD`
			`Operating System :: POSIX :: BSD :: OpenBSD`
			`Operating System :: POSIX :: BSD :: NetBSD`
			`Operating System :: MacOS :: MacOS X`
			`Operating System :: POSIX :: Linux`
			`Programming Language :: Python`
			`Programming Language :: Python :: 3`
			`Programming Language :: Python :: 3.9`
			`Programming Language :: Python :: 3.10`
add python 3.11 to pypi metadata 2022-06-03 07:59:40 +00:00			`Programming Language :: Python :: 3.11`
Initial commit 2022-03-23 11:19:18 +00:00			`Topic :: Security :: Cryptography`
			`Topic :: System :: Archiving :: Backup`
			`platforms = Linux, MacOS X, FreeBSD, OpenBSD, NetBSD`
			`license = BSD`
Use license_files instead of license_file Closes #6727 See: https://github.com/pypa/setuptools/pull/2620 2022-06-13 14:09:38 +00:00			`license_files = LICENSE`
Initial commit 2022-03-23 11:19:18 +00:00			`project_urls =`
			`Bug Tracker = https://github.com/borgbackup/borg/issues`
			`Documentation = https://borgbackup.readthedocs.io`
			`Source Code = https://github.com/borgbackup/borg`

			`[options]`
make setuptools happy, fixes #6874 (try 2, same as in 1.2-maint) work around setuptools puking about: ############################ # Package would be ignored # ############################ Python recognizes 'borg.cache_sync' as an importable package, but it is not listed in the `packages` configuration of setuptools. 'borg.cache_sync' has been automatically added to the distribution only because it may contain data files, but this behavior is likely to change in future versions of setuptools (and therefore is considered deprecated). Please make sure that 'borg.cache_sync' is included as a package by using the `packages` configuration field or the proper discovery methods (for example by using `find_namespace_packages(...)`/`find_namespace:` instead of `find_packages(...)`/`find:`). You can read more about "package discovery" and "data files" on setuptools documentation page. 2022-08-04 15:18:23 +00:00			`packages = find_namespace:`
Initial commit 2022-03-23 11:19:18 +00:00			`package_dir =`
			`=src`
			`python_requires = >=3.9`
			`install_requires =`
allow msgpack 1.0.5 also 2023-03-09 21:26:38 +00:00			`msgpack >=1.0.3, <=1.0.5`
Initial commit 2022-03-23 11:19:18 +00:00			`packaging`
clarify platformdirs requirements, fixes #7393 3.0.0 is only required for macOS due to breaking changes. 2.6.0 was the last breaking change for Linux/UNIX. 2023-03-01 12:18:12 +00:00			`platformdirs >=3.0.0, <4.0.0; sys_platform == 'darwin' # for macOS: breaking changes in 3.0.0,`
			`platformdirs >=2.6.0, <4.0.0; sys_platform != 'darwin' # for others: 2.6+ works consistently.`
Initial commit 2022-03-23 11:19:18 +00:00			`argon2-cffi`
			`tests_require =`
			`pytest`
			`zip_safe = False`
Add feedback, part 1 2022-03-23 13:19:43 +00:00			`# See also the MANIFEST.in file.`
			`# We want to install all the files in the package directories...`
			`include_package_data = true`

			`# ...except the source files which have been compiled (C extensions):`
			`[options.exclude_package_data]`
			`* =`
			`*.c`
			`*.h`
			`*.pyx`
Initial commit 2022-03-23 11:19:18 +00:00
Add src path to setup.cfg 2022-03-23 12:19:25 +00:00			`[options.packages.find]`
			`where = src`

Initial commit 2022-03-23 11:19:18 +00:00			`[options.entry_points]`
			`console_scripts =`
			`borg = borg.archiver:main`
			`borgfs = borg.archiver:main`

			`[options.extras_require]`
			`llfuse = llfuse >= 1.3.8`
			`pyfuse3 = pyfuse3 >= 3.1.1`
require/configure setuptools_scm via pyproject.toml 2022-04-07 17:11:15 +00:00			`nofuse =`
Initial commit 2022-03-23 11:19:18 +00:00
setup.cfg: fix pytest deprecation warning, fixes #2050 2017-01-14 22:06:16 +00:00			`[tool:pytest]`
use py.test for testing, document it locally (via tox) and also on travis ci. 2015-05-22 18:23:37 +00:00			`python_files = testsuite/*.py`
declare "allow_cache_wipe" marker in setup.cfg to avoid pytest warning Undeclared markers trigger a pytest warning: PytestUnknownMarkWarning: Unknown pytest.mark.allow_cache_wipe - is this a typo? 2020-05-23 21:48:47 +00:00			`markers =`
			`allow_cache_wipe`
add flake8 configuration (style checker) currently adjusted in a way it does not throw errors and warnings with the source as it is now. issues will get fixed over time and the exclude list shall get shorter. 2015-05-22 18:40:43 +00:00
			`[flake8]`
cleanup flake8 checks - make code style exceptions tailored to specific files, so that it's less likely that new violations creep into the code. 2021-03-18 09:59:59 +00:00			`# for reference ...`
			`# E402 module level import not at top`
			`# E501 line too long`
Fix typos (#6688) fix typos Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de> 2022-05-15 19:23:48 +00:00			`# F401 import unused`
cleanup flake8 checks - make code style exceptions tailored to specific files, so that it's less likely that new violations creep into the code. 2021-03-18 09:59:59 +00:00			`# F405 undefined or defined from star imports`
			`# F811 redef of unused var`
			`# #### Pick either W503, or W504 - latest recommendation from pep8 is to ignore W503`
			`# W503 line break before binary operator`
			`# W504 line break after binary operator`

			`# borg code style guidelines:`
black integration 2022-03-02 03:19:33 +00:00			`# Ignoring E203 due to https://github.com/PyCQA/pycodestyle/issues/373`
fix E402 2023-07-25 23:15:11 +00:00			`ignore = W503, E203, F405, E402`
cleanup flake8 checks - make code style exceptions tailored to specific files, so that it's less likely that new violations creep into the code. 2021-03-18 09:59:59 +00:00
			`# Code style violation exceptions:`
add flake8 style checking 2016-01-30 21:01:27 +00:00			`# please note that the values are adjusted so that they do not cause failures`
			`# with existing code. if you want to change them, you should first fix all`
			`# flake8 failures that appear with your change.`
cleanup flake8 checks - make code style exceptions tailored to specific files, so that it's less likely that new violations creep into the code. 2021-03-18 09:59:59 +00:00			`per_file_ignores =`
fix E402 2023-07-25 23:15:11 +00:00			`src/borg/archive.py:E501`
simplify flake8 configuration we use black since a while, so some stuff does not need to be ignored any more. 2023-07-25 21:11:27 +00:00			`src/borg/archiver/help_cmd.py:E501`
fix E402 2023-07-25 23:15:11 +00:00			`src/borg/cache.py:E501`
simplify flake8 configuration we use black since a while, so some stuff does not need to be ignored any more. 2023-07-25 21:11:27 +00:00			`src/borg/helpers/__init__.py:F401`
			`src/borg/platform/__init__.py:F401`
fix F401 2023-07-25 22:19:37 +00:00			`src/borg/testsuite/archiver/disk_full.py:F811`
			`src/borg/testsuite/archiver/return_codes.py:F811`
			`src/borg/testsuite/benchmark.py:F811`
fix E501 2023-07-25 23:10:24 +00:00			`src/borg/testsuite/platform.py:F811`
cleanup flake8 checks - make code style exceptions tailored to specific files, so that it's less likely that new violations creep into the code. 2021-03-18 09:59:59 +00:00
			`max_line_length = 120`
			`exclude = build,dist,.git,.idea,.cache,.tox`
add flake8 style checking 2016-01-30 21:01:27 +00:00
add mypy checking also added some .pyi files needed to check the cython code (taken from #5703 and updated). fixed "syntax error" in key.py. all mypy complaints not fixed yet. 2022-07-15 10:44:56 +00:00			`[mypy]`
			`python_version = 3.9`
			`strict_optional = False`
			`local_partial_types = True`
			`show_error_codes = True`
			`files = src/borg/*/.py`

			`[mypy-msgpack.*]`
			`ignore_missing_imports = True`
			`[mypy-llfuse]`
			`ignore_missing_imports = True`
			`[mypy-pyfuse3]`
			`ignore_missing_imports = True`
			`[mypy-trio]`
			`ignore_missing_imports = True`

			`[mypy-borg.crypto.low_level]`
			`ignore_missing_imports = True`
			`[mypy-borg.platform.*]`
			`ignore_missing_imports = True`