setup.cfg

[metadata]
name = salt-analytics-framework
description = Salt Analytics Framework
long_description = file: README.rst
long_description_content_type = text/x-rst
author = Pedro Algarvio
author_email = palgarvio@vmware.com
keywords = salt-extension
url = https://github.com/saltstack/salt-analytics-framework
project_urls =
    Source=https://github.com/saltstack/salt-analytics-framework
    Tracker=https://github.com/saltstack/salt-analytics-framework/issues
license = Apache Software License
classifiers =
    Programming Language :: Python
    Programming Language :: Cython
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3 :: Only
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Development Status :: 4 - Beta
    Intended Audience :: Developers
    License :: OSI Approved :: Apache Software License
platforms = any

[options]
zip_safe = False
include_package_data = True
package_dir =
    =src
packages = find_namespace:
python_requires = >= 3.7
setup_requires =
  wheel
  setuptools>=50.3.2
  setuptools_scm[toml]>=3.4
  setuptools-declarative-requirements

[options.packages.find]
where = src
exclude =
    tests

[options.package_data]
saf = py.typed

[options.entry_points]
salt.loader =
  salt-analytics-framework = saf.saltext
saf.collect =
  beacons = saf.collect.beacons
  file = saf.collect.file
  salt_exec = saf.collect.salt_exec
  test = saf.collect.test
saf.process =
  regex_mask = saf.process.regex_mask
  shannon_mask = saf.process.shannon_mask
  jupyter_notebook = saf.process.jupyter_notebook
  test = saf.process.test
saf.forward =
  disk = saf.forward.disk
  noop = saf.forward.noop
  test = saf.forward.test


[requirements-files]
install_requires = requirements/base.txt
tests_require = requirements/tests.txt
extras_require =
  dev = requirements/dev.txt
  tests = requirements/tests.txt
  docs = requirements/docs.txt
  docsauto = requirements/docs-auto.txt
  changelog = requirements/changelog.txt
  build = requirements/build.txt
  jupyter = requirements/jupyter.txt


[bdist_wheel]
# Use this option if your package is pure-python
universal = 1

[build_sphinx]
source_dir = docs
build_dir = build/sphinx

[sdist]
owner = root
group = root

[flake8]
max-line-length = 120
exclude =
  # No need to traverse our git directory
  .git,
  # Nox virtualenvs are also not important
  .nox,
  # There's no value in checking cache directories
  __pycache__,
  # Don't check the auto generated version file
  src/saf/version.py,
  # Package build stuff
  build,
  dist,
  # Exclude the demo directory
  demo,
  # The conf file is mostly autogenerated, ignore it
  docs/conf.py,
  # Also ignore setup.py, it's mostly a shim
  setup.py,
  # Ignore our custom pre-commit hooks
  .pre-commit-hooks

per-file-ignores =
  # F401 imported but unused
  __init__.py: F401
  # D100 Missing docstring in public module
  # D103 Missing docstring in public function
  noxfile.py: D100,D102,D103,D107,D212,E501
  # D106 Missing docstring in public nested class
  src/saf/models.py: D106,
  # D100 Missing docstring in public module
  # D103 Missing docstring in public function
  tests/*.py: D100,D103

ignore =
  # D104 Missing docstring in public package
  D104,
  # D107 Missing docstring in __init__ - Class docstrings will cover __init__ docstrings
  D107,
  # D212 Multi-line docstring summary should start at the first line
  D212,
  # D200 One-line docstring should fit on one line with quotes
  D200,

# Additional builtins
builtins =
  # __salt__ dunder
  __salt__
  # __opts__ dictionary
  __opts__
  # The system encoding that Salt injects into the globals
  __salt_system_encoding__

# flake8-docstrings config
docstring-convention = google


[mypy]
python_version = 3.7
mypy_path = src
ignore_missing_imports = True
no_implicit_optional = True
show_error_codes = True
strict_equality = True
warn_redundant_casts = True
warn_unreachable = True
warn_no_return = True
warn_return_any = True
warn_unused_configs = True
warn_unused_ignores = True
disallow_any_generics = True
check_untyped_defs = True
no_implicit_reexport = True
explicit_package_bases = True

# for strict mypy: (this is the tricky one :-))
#disallow_untyped_defs = True

plugins = pydantic.mypy

[mypy-saf.*]
# for strict mypy: (this is the tricky one :-))
disallow_untyped_defs = True

[mypy-tests.*]
disallow_untyped_defs = False

[pydantic-mypy]
init_forbid_extra = True
init_typed = True
warn_required_dynamic_aliases = True
warn_untyped_fields = True