pyproject.toml

[tool.poetry]
name = "nornir-nautobot"
version = "3.2.0"
description = "Nornir Nautobot"
authors = ["Network to Code, LLC <opensource@networktocode.com>"]
readme = "README.md"
license = "Apache-2.0"
keywords = ["Nautobot"]
classifiers = [
  "Intended Audience :: Developers",
  "Development Status :: 5 - Production/Stable",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
]
repository = "https://github.com/nautobot/nornir-nautobot"
homepage = "https://nautobot.com"
documentation = "https://nornir-nautobot.readthedocs.io"

[tool.poetry.urls]
"Changelog" = "https://docs.nautobot.com/projects/nornir-nautobot/en/latest/dev/CHANGELOG/"
"Bug Tracker" = "https://github.com/nautobot/nornir-nautobot/issues"

[tool.poetry.dependencies]
python = "^3.8"
nornir = "^3.0.0"
requests = "^2.25.1"
nornir-utils = "^0"
nornir-napalm = ">=0.4.0 <1.0.0"
nornir-jinja2 = "^0.2.0"
nornir-netmiko = "^1"
pynautobot = ">=2.0.2"
netutils = "^1.6.0"
routeros-api = {version = "^0.17.0", optional = true}
httpx = ">=0.23.0,<=0.27.0"

[tool.poetry.dev-dependencies]
pytest = "*"
requests_mock = "*"
pyyaml = "*"
black = "*"
pylint = "*"
pydocstyle = "*"
yamllint = "*"
bandit = "*"
invoke = "*"
toml = "*"
flake8 = "*"
pydantic = {version = "^1.7.2", extras = ["dotenv"]}
# documentation dependencies
mkdocs = "1.5.2"
mkdocs-material = "9.2.4"
mkdocstrings = "0.22.0"
mkdocstrings-python = "1.5.2"
mkdocs-version-annotations = "1.0.0"

[tool.poetry.extras]
mikrotik_driver = ["routeros-api"]

[tool.poetry.plugins."nornir.plugins.inventory"]
"NautobotInventory" = "nornir_nautobot.plugins.inventory.nautobot:NautobotInventory"

[tool.black]
line-length = 120
target-version = ['py38', 'py39', 'py310', 'py311']
include = '\.pyi?$'
exclude = '''
(
  /(
      \.eggs         # exclude a few common directories in the
    | \.git          # root of the project
    | \.hg
    | \.mypy_cache
    | \.tox
    | \.venv
    | _build
    | buck-out
    | build
    | dist
  )/
  | settings.py     # This is where you define files that should not be stylized by black
                     # the root of the project
)
'''

[tool.pylint.basic]
# No docstrings required for private methods (Pylint default), or for test_ functions, or for inner Meta classes.
no-docstring-rgx="^(_|test_|Meta$)"


[tool.pylint.messages_control]
# Line length is enforced by Black, so pylint doesn't need to check it.
# Pylint and Black disagree about how to format multi-line arrays; Black wins.
disable = """,
    line-too-long,
    duplicate-code,
    """

[tool.pylint.miscellaneous]
# Don't flag TODO as a failure, let us commit with things that still need to be done in the code
notes = """,
    FIXME,
    XXX,
    """

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.pytest.ini_options]
testpaths = "tests/"
addopts = "-vv"