pyproject.toml

[project]
authors = [
  {name = "Joao Miguel Correia Teixeira", email = "joaomcteixeira@gmail.com"},
]
description = "A skeleton template for Python projects."
license = {text = "MIT"}
name = "jmct-sampleproject"
readme = "README.rst"

# complete classifier list:
# http://pypi.org/classifiers/
classifiers = [
  'Development Status :: 4 - Beta', # 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
  'License :: OSI Approved :: MIT License',
  'Intended Audience :: Science/Research',
  'Natural Language :: English',
  'Operating System :: POSIX',
  'Operating System :: MacOS',
  'Operating System :: Microsoft',
  'Programming Language :: Python :: 3.8',
  'Programming Language :: Python :: 3.9',
  'Programming Language :: Python :: 3.10',
  'Programming Language :: Python :: 3.11',
  "Development Status :: 4 - Beta",
  "Programming Language :: Python :: 3",
  "License :: OSI Approved :: MIT License",
]

keywords = [
  'ci',
  'continuous-integration',
  'project-template',
  'project-skeleton',
  'sample-project', # eg: 'keyword1', 'keyword2', 'keyword3',
]

dependencies = [
  # https://stackoverflow.com/questions/14399534
  'pandas>=1.2',
  'deprecated',
  "attrs",
]
requires-python = ">=3.8, <4"

dynamic = ["version"]

[project.urls]
changelog = "https://github.com/joaomcteixeira/python-project-skeleton/blob/main/CHANGELOG.rst"
documentation = "https://python-project-skeleton.readthedocs.io/en/latest/"
homepage = "https://github.com/joaomcteixeira/python-project-skeleton"
repository = "https://github.com/joaomcteixeira/python-project-skeleton.git"

[project.optional-dependencies]
# Add dependencies for building docs and running tests
docs = [
  "sphinx>=2.2",
  "sphinx-argparse",
  "sphinx-rtd-theme",
  "myst_nb",
  "ipython",
]

test = [
  "coverage",
  "pytest",
  "pytest-cov",
  "hypothesis",
]

[project.scripts]
# samplecli1 = "sampleproject.cli_int1:main"

[tool.pytest.ini_options]
# If a pytest section is found in one of the possible config files
# (pytest.ini, tox.ini or setup.cfg), then pytest will not look for any others,
# so if you add a pytest config section elsewhere,
# you will need to delete this section from setup.cfg.
#norecursedirs =
#migrations
addopts = "-p pytest_cov"
python_files = [
  "test_*.py",
  "*_test.py",
  "tests.py",
]
#addopts =
#    -ra
#    --strict
#    --doctest-modules
#    --doctest-glob=\*.rst
#    --tb=short
testpaths = [
  "tests",
]

[tool.ruff]
builtins = ["ellipsis"]
target-version = "py38"

[tool.ruff.lint]
exclude = [
  ".eggs",
  "doc",
  "_typed_ops.pyi",
]
# E402: module level import not at top of file
# E501: line too long - let black worry about that
# E731: do not assign a lambda expression, use a def
# E741: ambiguous variable names
ignore = [
  "E402",
  "E501",
  "E731",
  "E741",
]
select = [
  "F", # Pyflakes
  "E", # Pycodestyle
  "W", # isort
  "I",
  "UP", # Pyupgrade
]

[tool.ruff.lint.per-file-ignores]
# F401: imported but unsued
"__init__.py" = ["F401"]

[tool.ruff.lint.isort]
known-first-party = ["sampleproject"]
lines-after-imports = 2

[tool.setuptools_scm]
fallback_version = "999"

[build-system]
build-backend = "setuptools.build_meta"
requires = ["setuptools>=46.1.0", "setuptools_scm[toml]>=6.2"]