setup.cfg

##########################
# Setup.py Configuration #
##########################
[metadata]
name = scp_lf
version = 0.0.1-dev
description = This is a test package
long_description = file: README.md
long_description_content_type = text/markdown

# URLs associated with the project
url = https://github.com/reypark/scp_lf
download_url = https://github.com/reypark/scp_lf/releases
project_urls =
    Tracker = https://github.com/reypark/scp_lf/issues
    Source = https://github.com/reypark/scp_lf
    Documentation = https://scp_lf.readthedocs.io

# Author information
author = Parker Reyes
author_email = reyespar@byu.edu
maintainer = Parker Reyes
maintainer_email = reyespar@byu.edu

# License Information
license = MIT
license_files =
    LICENSE

# Search tags
classifiers =
    Development Status :: 1 - Planning
    Environment :: Console
    Intended Audience :: Developers
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent
    Framework :: Pytest
    Framework :: tox
    Framework :: Sphinx
    Programming Language :: Python
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10
    Programming Language :: Python :: 3.11
    Programming Language :: Python :: 3.12
    Programming Language :: Python :: 3 :: Only
    # TODO add your topics from the Trove controlled vocabulary (see https://pypi.org/classifiers)
keywords =
    snekpack
    cookiecutter
    # TODO add your own free-text keywords

[options]
install_requires =
    # Missing itertools from the standard library you didn't know you needed
    more_itertools
    # Use progress bars excessively
    tqdm
    # Command line tools
    click
    more_click
    # TODO your requirements go here

# Random options
zip_safe = false
include_package_data = True
python_requires = >=3.8 # use the python foundation version they are still reviewing

# Where is my code
packages = find:
package_dir =
    = src

[options.packages.find]
where = src

[options.extras_require]
tests =
    pytest
    coverage
# web =
#     flask
#     fastapi
#     # TODO add your web dependencies
docs =
    sphinx
    sphinx-rtd-theme
    sphinx-click
    sphinx_automodapi
    # Remove if your project doesn't use Pydantic
    autodoc_pydantic
    # To include LaTeX comments easily in your docs. 
    # If you uncomment this, don't forget to do the same in docs/conf.py
    # texext


[options.entry_points]
console_scripts =
    scp_lf = scp_lf.cli:main


######################
# Doc8 Configuration #
# (doc8.ini)         #
######################
[doc8]
max-line-length = 120

##########################
# Coverage Configuration #
# (.coveragerc)          #
##########################
[coverage:run]
branch = True
source = scp_lf
omit =
    tests/*
    docs/*

[coverage:paths]
source =
    src/scp_lf
    .tox/*/lib/python*/site-packages/scp_lf

[coverage:report]
show_missing = True
exclude_lines =
    pragma: no cover
    raise NotImplementedError
    if __name__ == "__main__":
    if TYPE_CHECKING:
    def __str__
    def __repr__

##########################
# Darglint Configuration #
##########################
[darglint]
docstring_style = sphinx
strictness = short

[darglint2]
docstring_style = sphinx
strictness = short

#######################
# MyPy Configuration  #
#######################
[mypy]
plugins = pydantic.mypy

#########################
# Flake8 Configuration  #
# (.flake8)             #
#########################
[flake8]
exclude =
    .tox,
    .git,
    __pycache__,
    docs/source/conf.py,
    build,
    dist,
    tests/fixtures/*,
    *.pyc,
    *.egg-info,
    .cache,
    .eggs,
    data
max-line-length = 120
max-complexity = 20
import-order-style = pycharm
application-import-names =
    scp_lf
    tests