diff --git a/.coveragerc b/.coveragerc deleted file mode 100644 index 8d78d7f..0000000 --- a/.coveragerc +++ /dev/null @@ -1,6 +0,0 @@ -[run] -command_line= -m pytest - -[report] -include = - pyats_genie_command_parse/* diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml index 81e79d3..84170f4 100644 --- a/.github/workflows/publish-to-pypi.yml +++ b/.github/workflows/publish-to-pypi.yml @@ -18,7 +18,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v4 with: - python-version: 3.7.15 + python-version: 3.8 - name: Install dependencies run: | @@ -29,5 +29,5 @@ jobs: TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} run: | - python setup.py sdist bdist_wheel + make build twine upload dist/* diff --git a/.github/workflows/test-coverage-lint.yml b/.github/workflows/test-coverage-lint.yml index 3c4be0b..e5aef58 100644 --- a/.github/workflows/test-coverage-lint.yml +++ b/.github/workflows/test-coverage-lint.yml @@ -24,7 +24,6 @@ jobs: strategy: matrix: python-version: - - 3.7 - 3.8 - 3.9 - '3.10' @@ -35,18 +34,18 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - - name: Install dependencies MAIN + - name: Upgrade pip setuptools wheel run: | python -m pip install --upgrade pip setuptools wheel - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Install dependencies TESTS for some reason doing it in one install creates backtracking + - name: Install requirements from requirements-dev.txt run: | - if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi - - name: Test with pytest and coverage + pip install -r requirements-dev.txt + - name: Run Linting run: | - coverage erase - coverage run - coverage report - - name: Lint with pylint + make pylint + - name: Run Unit-Testing and Coverage run: | - pylint ./pyats_genie_command_parse/pyats_genie_command_parse.py + make coverage + - name: Run Build + run: | + make build diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..cdc56b1 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: "ubuntu-22.04" + tools: + python: "3.8" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: requirements-dev.txt diff --git a/LICENSE b/LICENSE index cbaf163..8c4d2c7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 - 2022 Benjamin Trachtenberg +Copyright (c) 2020 - 2023 Benjamin Trachtenberg Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..a702792 --- /dev/null +++ b/Makefile @@ -0,0 +1,29 @@ +# Makefile for project needs +# Author: Ben Trachtenberg +# Version: 1.0.3 +# + +.PHONY: info app-run coverage pylint pytest gh-pages pdf build + +info: + @echo "make options" + @echo " build To build" + @echo " coverage To run coverage and display ASCII and output to htmlcov" + @echo " pylint To run pylint" + @echo " pytest To run pytest with verbose option" + @echo " pdf To create PDF Docs" + +build: + @python -m build + +coverage: + @pytest --cov --cov-report=html -vvv + +pylint: + @pylint pyats_genie_command_parse/ + +pytest: + @pytest --cov -vvv + +pdf: + @sphinx-build -b rinoh ./docs ./docs/_build/pdf diff --git a/docs/conf.py b/docs/conf.py index 62329b1..ed4ecc1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,12 +12,19 @@ # import os import sys +import tomli base_path = os.path.split(os.path.join(os.path.abspath(os.path.dirname(__name__))))[0] sys.path.append(base_path) -about = {} + +# Reads version.py and converts to a dict of keys +version_py = {} with open(os.path.join(base_path, 'pyats_genie_command_parse', 'version.py'), 'r', encoding='utf-8') as f: - exec(f.read(), about) + exec(f.read(), version_py) +# Reads pyproject.toml and converts to python objects +with open(os.path.join(base_path, 'pyproject.toml'), 'r', encoding='utf-8') as file: + toml = file.read() +pyproject_toml = tomli.loads(toml) # -- Added for readthedocs.org ----------------------------------------------- @@ -26,11 +33,16 @@ # -- Project information ----------------------------------------------------- # The full version, including alpha/beta/rc tags -release = about['__version__'] +release = version_py['__version__'] +project = f"{pyproject_toml['project']['name']} v{release}" +copyright = version_py['__copyright__'] + +# Reads authors from pyproject.toml and adds name to list +authors = [] +for author_name in pyproject_toml['project']['authors']: + authors.append(author_name.get('name')) -project = f'{about["__title__"]} v{release}' -copyright = about['__copyright__'] -author = about['__author__'] +author = ','.join(authors) # -- General configuration --------------------------------------------------- diff --git a/pyats_genie_command_parse/__init__.py b/pyats_genie_command_parse/__init__.py index a66c19a..c3751da 100644 --- a/pyats_genie_command_parse/__init__.py +++ b/pyats_genie_command_parse/__init__.py @@ -1,4 +1,4 @@ """ init for pyats_genie_command_parse """ -from .pyats_genie_command_parse import GenieCommandParse +from pyats_genie_command_parse.pyats_genie_command_parse import GenieCommandParse diff --git a/pyats_genie_command_parse/version.py b/pyats_genie_command_parse/version.py index a73f4e6..3137005 100644 --- a/pyats_genie_command_parse/version.py +++ b/pyats_genie_command_parse/version.py @@ -1,15 +1,7 @@ """ Holds the version information for the package """ -__title__ = 'pyats-genie-command-parse' -__description__ = 'Run genie parsers directly.' -__author__ = 'Benjamin P. Trachtenberg, Brett Gianpetro' __copyright__ = "Copyright (c) 2020 - 2023, Benjamin P. Trachtenberg, Brett Gianpetro" -__credits__ = None -__license__ = 'The MIT License (MIT)' __status__ = 'prod' -__version_info__ = (1, 3, 4) +__version_info__ = (1, 3, 5) __version__ = '.'.join(map(str, __version_info__)) -__maintainer__ = 'Benjamin P. Trachtenberg' -__email__ = 'e_ben_75-python@yahoo.com' -__url__ = 'https://pyats-genie-command-parse.readthedocs.io' diff --git a/pylintrc b/pylintrc deleted file mode 100644 index a7a88fa..0000000 --- a/pylintrc +++ /dev/null @@ -1,624 +0,0 @@ -[MAIN] - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Clear in-memory caches upon conclusion of linting. Useful if running pylint -# in a server-like mode. -clear-cache-post-run=no - -# Load and enable all available extensions. Use --list-extensions to see a list -# all available extensions. -#enable-all-extensions= - -# In error mode, messages with a category besides ERROR or FATAL are -# suppressed, and no reports are done by default. Error mode is compatible with -# disabling specific errors. -#errors-only= - -# Always return a 0 (non-error) status code, even if lint errors are found. -# This is primarily useful in continuous integration scripts. -#exit-zero= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. -extension-pkg-allow-list= - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code. (This is an alternative name to extension-pkg-allow-list -# for backward compatibility.) -extension-pkg-whitelist= - -# Return non-zero exit code if any of these messages/categories are detected, -# even if score is above --fail-under value. Syntax same as enable. Messages -# specified are enabled, while categories only check already-enabled messages. -fail-on= - -# Specify a score threshold under which the program will exit with error. -fail-under=10 - -# Interpret the stdin as a python script, whose filename needs to be passed as -# the module_or_package argument. -#from-stdin= - -# Files or directories to be skipped. They should be base names, not paths. -ignore=CVS - -# Add files or directories matching the regular expressions patterns to the -# ignore-list. The regex matches against paths and can be in Posix or Windows -# format. Because '\\' represents the directory delimiter on Windows systems, -# it can't be used as an escape character. -ignore-paths= - -# Files or directories matching the regular expression patterns are skipped. -# The regex matches against base names, not paths. The default value ignores -# Emacs file locks -ignore-patterns=^\.# - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis). It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the -# number of processors available to use, and will cap the count on Windows to -# avoid hangs. -jobs=1 - -# Control the amount of potential inferred values when inferring a single -# object. This can help the performance when dealing with large functions or -# complex, nested conditions. -limit-inference-results=100 - -# List of plugins (as comma separated values of python module names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Minimum Python version to use for version dependent checks. Will default to -# the version used to run pylint. -py-version=3.7 - -# Discover python modules and packages in the file system subtree. -recursive=no - -# When enabled, pylint would attempt to guess common misconfiguration and emit -# user-friendly hints instead of false-positive error messages. -suggestion-mode=yes - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - -# In verbose mode, extra non-checker-related info will be displayed. -#verbose= - - -[BASIC] - -# Naming style matching correct argument names. -argument-naming-style=snake_case - -# Regular expression matching correct argument names. Overrides argument- -# naming-style. If left empty, argument names will be checked with the set -# naming style. -#argument-rgx= - -# Naming style matching correct attribute names. -attr-naming-style=snake_case - -# Regular expression matching correct attribute names. Overrides attr-naming- -# style. If left empty, attribute names will be checked with the set naming -# style. -#attr-rgx= - -# Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata - -# Bad variable names regexes, separated by a comma. If names match any regex, -# they will always be refused -bad-names-rgxs= - -# Naming style matching correct class attribute names. -class-attribute-naming-style=any - -# Regular expression matching correct class attribute names. Overrides class- -# attribute-naming-style. If left empty, class attribute names will be checked -# with the set naming style. -#class-attribute-rgx= - -# Naming style matching correct class constant names. -class-const-naming-style=UPPER_CASE - -# Regular expression matching correct class constant names. Overrides class- -# const-naming-style. If left empty, class constant names will be checked with -# the set naming style. -#class-const-rgx= - -# Naming style matching correct class names. -class-naming-style=PascalCase - -# Regular expression matching correct class names. Overrides class-naming- -# style. If left empty, class names will be checked with the set naming style. -#class-rgx= - -# Naming style matching correct constant names. -const-naming-style=UPPER_CASE - -# Regular expression matching correct constant names. Overrides const-naming- -# style. If left empty, constant names will be checked with the set naming -# style. -#const-rgx= - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming style matching correct function names. -function-naming-style=snake_case - -# Regular expression matching correct function names. Overrides function- -# naming-style. If left empty, function names will be checked with the set -# naming style. -#function-rgx= - -# Good variable names which should always be accepted, separated by a comma. -good-names=i, - j, - k, - ex, - Run, - _ - -# Good variable names regexes, separated by a comma. If names match any regex, -# they will always be accepted -good-names-rgxs= - -# Include a hint for the correct naming format with invalid-name. -include-naming-hint=no - -# Naming style matching correct inline iteration names. -inlinevar-naming-style=any - -# Regular expression matching correct inline iteration names. Overrides -# inlinevar-naming-style. If left empty, inline iteration names will be checked -# with the set naming style. -#inlinevar-rgx= - -# Naming style matching correct method names. -method-naming-style=snake_case - -# Regular expression matching correct method names. Overrides method-naming- -# style. If left empty, method names will be checked with the set naming style. -#method-rgx= - -# Naming style matching correct module names. -module-naming-style=snake_case - -# Regular expression matching correct module names. Overrides module-naming- -# style. If left empty, module names will be checked with the set naming style. -#module-rgx= - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -# These decorators are taken in consideration only for invalid-name. -property-classes=abc.abstractproperty - -# Regular expression matching correct type variable names. If left empty, type -# variable names will be checked with the set naming style. -#typevar-rgx= - -# Naming style matching correct variable names. -variable-naming-style=snake_case - -# Regular expression matching correct variable names. Overrides variable- -# naming-style. If left empty, variable names will be checked with the set -# naming style. -#variable-rgx= - - -[CLASSES] - -# Warn about protected attribute access inside special methods -check-protected-access-in-special-methods=no - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__, - __new__, - setUp, - __post_init__ - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict, - _fields, - _replace, - _source, - _make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# List of regular expressions of class ancestor names to ignore when counting -# public methods (see R0903) -exclude-too-few-public-methods= - -# List of qualified class names to ignore when counting class parents (see -# R0901) -ignored-parents= - -# Maximum number of arguments for function / method. -max-args=5 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Maximum number of boolean expressions in an if statement (see R0916). -max-bool-expr=5 - -# Maximum number of branch for function / method body. -max-branches=12 - -# Maximum number of locals for function / method body. -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body. -max-returns=6 - -# Maximum number of statements in function / method body. -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when caught. -overgeneral-exceptions=builtins.BaseException,builtins.Exception - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=120 - -# Maximum number of lines in a module. -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[IMPORTS] - -# List of modules that can be imported at any level, not just the top level -# one. -allow-any-import-level= - -# Allow explicit reexports by alias from a package __init__. -allow-reexport-from-package=no - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Deprecated modules which should not be used, separated by a comma. -deprecated-modules= - -# Output a graph (.gv or any supported image format) of external dependencies -# to the given file (report RP0402 must not be disabled). -ext-import-graph= - -# Output a graph (.gv or any supported image format) of all (i.e. internal and -# external) dependencies to the given file (report RP0402 must not be -# disabled). -import-graph= - -# Output a graph (.gv or any supported image format) of internal dependencies -# to the given file (report RP0402 must not be disabled). -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - -# Couples of modules and preferred modules, separated by a comma. -preferred-modules= - - -[LOGGING] - -# The type of string formatting that logging methods do. `old` means using % -# formatting, `new` is for `{}` formatting. -logging-format-style=old - -# Logging modules to check that the string format arguments are in logging -# function parameter format. -logging-modules=logging - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, -# UNDEFINED. -confidence=HIGH, - CONTROL_FLOW, - INFERENCE, - INFERENCE_FAILURE, - UNDEFINED - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once). You can also use "--disable=all" to -# disable everything first and then re-enable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use "--disable=all --enable=classes -# --disable=W". -disable=raw-checker-failed, - bad-inline-option, - locally-disabled, - file-ignored, - suppressed-message, - useless-suppression, - deprecated-pragma, - use-symbolic-message-instead - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable=c-extension-no-member - - -[METHOD_ARGS] - -# List of qualified names (i.e., library.method) which require a timeout -# parameter e.g. 'requests.api.get,requests.api.post' -timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - -# Regular expression of note tags to take in consideration. -notes-rgx= - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - -# Complete name of functions that never returns. When checking for -# inconsistent-return-statements if a never returning function is called then -# it will be considered as an explicit return statement and no message will be -# printed. -never-returning-functions=sys.exit,argparse.parse_error - - -[REPORTS] - -# Python expression which should return a score less than or equal to 10. You -# have access to the variables 'fatal', 'error', 'warning', 'refactor', -# 'convention', and 'info' which contain the number of messages in each -# category, as well as 'statement' which is the total number of statements -# analyzed. This score is used by the global evaluation report (RP0004). -evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details. -msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio). You can also give a reporter class, e.g. -# mypackage.mymodule.MyReporterClass. -#output-format= - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[SIMILARITIES] - -# Comments are removed from the similarity computation -ignore-comments=yes - -# Docstrings are removed from the similarity computation -ignore-docstrings=yes - -# Imports are removed from the similarity computation -ignore-imports=yes - -# Signatures are removed from the similarity computation -ignore-signatures=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[SPELLING] - -# Limits count of emitted suggestions for spelling mistakes. -max-spelling-suggestions=4 - -# Spelling dictionary name. Available dictionaries: none. To make it work, -# install the 'python-enchant' package. -spelling-dict= - -# List of comma separated words that should be considered directives if they -# appear at the beginning of a comment and should not be checked. -spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains the private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to the private dictionary (see the -# --spelling-private-dict-file option) instead of raising a message. -spelling-store-unknown-words=no - - -[STRING] - -# This flag controls whether inconsistent-quotes generates a warning when the -# character used as a quote delimiter is used inconsistently within a module. -check-quote-consistency=no - -# This flag controls whether the implicit-str-concat should generate a warning -# on implicit string concatenation in sequences defined over several lines. -check-str-concat-over-line-jumps=no - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether to warn about missing members when the owner of the attribute -# is inferred to be None. -ignore-none=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of symbolic message names to ignore for Mixin members. -ignored-checks-for-mixins=no-member, - not-async-context-manager, - not-context-manager, - attribute-defined-outside-init - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - -# Regex pattern to define which classes are considered mixins. -mixin-class-rgx=.*[Mm]ixin - -# List of decorators that change the signature of a decorated function. -signature-mutators= - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid defining new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of names allowed to shadow builtins -allowed-redefined-builtins= - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_, - _cb - -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..570a645 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,92 @@ +[build-system] +requires = [ + "setuptools>=67.6.0", + "wheel>=0.40.0" +] +build-backend = "setuptools.build_meta" + +[project] +name = "pyats-genie-command-parse" +dynamic = ["version", "readme", "dependencies"] +requires-python = ">=3.8, <3.11" +description = "Run genie parsers directly." +keywords = [ + "pyATS", + "genie", + "cisco", + "ios", + "ios-xr", + "nxos", + "parse", + "wrapper", +] +authors = [ + { name="Benjamin P. Trachtenberg", email="e_ben_75-python@yahoo.com" }, + { name="Brett Gianpetro", email="e_ben_75-python@yahoo.com" }, +] +maintainers = [ + {name = "Benjamin P. Trachtenberg", email = "e_ben_75-python@yahoo.com"}, +] +license = {file = "LICENSE"} +classifiers = [ + "Development Status :: 5 - Production/Stable", + "License :: OSI Approved :: MIT License", + "Intended Audience :: Developers", + "Natural Language :: English", + "Operating System :: POSIX", + "Operating System :: POSIX :: BSD", + "Operating System :: POSIX :: Linux", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", +] + +[project.urls] +Documentation = "https://pyats-genie-command-parse.readthedocs.io/en/latest/" +Source = "https://github.com/btr1975/pyats-genie-command-parse" +Tracker = "https://github.com/btr1975/pyats-genie-command-parse/issues" + +[tool.setuptools.packages.find] +include = [ + "pyats_genie_command_parse*", +] + +# Add or remove file extensions to include the data +[tool.setuptools.package-data] +"*" = ["*.txt", "*.rst"] + +[tool.setuptools] +zip-safe = false + +[tool.setuptools.dynamic] +version = {attr = "pyats_genie_command_parse.version.__version__"} +readme = {file = "README.md", content-type = "text/markdown"} +dependencies = {file = "requirements.txt"} + +[tool.distutils.bdist_wheel] +universal = true + +[tool.pytest.ini_options] +addopts = "--strict-markers" +markers = [ + "generic_tests: marks tests as generic_tests (deselect with -m not generic_tests)", + "ios_tests: marks tests as ios_tests (deselect with -m not ios_tests)", +] + +[tool.coverage.run] +command_line= "-m pytest -vvv" + +[tool.coverage.report] +include = [ + "pyats_genie_command_parse/*" +] + +[tool.pylint] +max-line-length = 120 +# This allows pylint to complain on FIXME and XXX notes +notes = [ + "FIXME", + "XXX", +] diff --git a/pytest.ini b/pytest.ini deleted file mode 100644 index 06c575f..0000000 --- a/pytest.ini +++ /dev/null @@ -1,5 +0,0 @@ -[pytest] -addopts = --strict-markers -markers = - generic_tests: marks tests as generic_tests (deselect with '-m "not generic_tests"') - ios_tests: marks tests as ios_tests (deselect with '-m "not ios_tests"') diff --git a/requirements-dev.txt b/requirements-dev.txt index e81ac9b..9258730 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,4 +1,7 @@ +-r requirements.txt +build~=0.10.0 +tomli~=2.0.1 pytest-cov~=4.0.0 -Sphinx~=5.3.0 -pylint~=2.16.4 +sphinx~=6.1.3 +pylint~=2.17.0 twine~=4.0.2 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 33aea03..0000000 --- a/setup.cfg +++ /dev/null @@ -1,5 +0,0 @@ -[metadata] -license_files = LICENSE - -[bdist_wheel] -universal=1 diff --git a/setup.py b/setup.py deleted file mode 100644 index 8a88115..0000000 --- a/setup.py +++ /dev/null @@ -1,62 +0,0 @@ -from setuptools import setup -import os - -base_dir = os.path.abspath(os.path.dirname(__file__)) -with open(os.path.join(base_dir, 'README.md'), encoding='utf-8') as f: - long_description = f.read() - -about = {} -with open(os.path.join(base_dir, 'pyats_genie_command_parse', 'version.py'), 'r', encoding='utf-8') as f: - exec(f.read(), about) - -packages = [ - 'pyats_genie_command_parse' -] - -install_requires = [ - 'pyats == 23.2', - 'genie == 23.2', -] - -tests_require = [ - 'pytest', -] - -setup( - name=about['__title__'], - version=about['__version__'], - python_requires='>=3.7', - description=about['__description__'], - long_description=long_description, - long_description_content_type='text/markdown', - keywords='pyATS genie cisco ios ios-xr nxos parse wrapper', - url=about['__url__'], - project_urls={ - 'Documentation': 'https://pyats-genie-command-parse.readthedocs.io/en/latest/', - 'Source': 'https://github.com/btr1975/pyats-genie-command-parse', - 'Tracker': 'https://github.com/btr1975/pyats-genie-command-parse/issues', - }, - author=about['__author__'], - author_email=about['__email__'], - license=about['__license__'], - packages=packages, - include_package_data=True, - install_requires=install_requires, - test_suite='pytest', - tests_require=tests_require, - classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'License :: OSI Approved :: MIT License', - 'Intended Audience :: Developers', - 'Natural Language :: English', - 'Operating System :: POSIX', - 'Operating System :: POSIX :: BSD', - 'Operating System :: POSIX :: Linux', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3 :: Only', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - ], -) diff --git a/tests/test_ios_parse.py b/tests/test_ios_parse.py index ef57065..d8b6de7 100644 --- a/tests/test_ios_parse.py +++ b/tests/test_ios_parse.py @@ -11,7 +11,6 @@ def test_ios_show_ip_interface_brief(ios_command_parse_object, ios_show_ip_inter assert returned_data == ios_show_ip_interface_brief_dict - @pytest.mark.ios_tests def test_ios_show_interfaces(ios_command_parse_object, ios_show_interfaces_native, ios_show_interfaces_dict): returned_data = ios_command_parse_object.parse_string(show_command='show interfaces',