template_python_library/pyproject.toml at main · gattia/template_python_library · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
#https://peps.python.org/pep-0621
#pyproject.toml requirements:
#https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
# also some ideas from scikit:
# https://scikit-hep.org/developer/pep621

#Specify the requirements needed to build the package.
[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"

#Specify the requirements needed to build the project itself.
#Instructions for defining the project info
[project]
name = "template_python_library"
description = "My package description"
readme = "README.md"
requires-python = ">=3.7"
keywords = ["python"]
license = {text = "MIT"}
authors = [
  { name = "Anthony Gatti", email = "anthony.a.gatti@gmail.com" },
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "License :: OSI Approved :: MIT License",
    "Topic :: Scientific/Engineering",
    "Programming Language :: Python :: 3",
]
dependencies = []
dynamic = ["version"]


[project.urls]
Homepage = "https://github.com/gattia/template_python_library/"  # {REPLACE}
# build the documentation using github pages, for others will go to github.io, I have redirected to:
Documentation = "https://anthonygattiphd.com/template_python_library/"   #{REPLACE}

# Dynamic metadata - E.g., version here.
# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#dynamic-metadata
[tool.setuptools.dynamic]
version = {attr = "template_python_library.__version__"} # {REPLACE}

# setuptools specific items
[tool.setuptools]
packages = ['template_python_library']  # location of the package {REPLACE}

# information about "tools"
[tool.isort]
profile = "black"
multi_line_output = 3
line_length = 100
include_trailing_comma = true
sections = ['FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER']
known_first_party = ["cython_functions"]

[tool.black]
line-length = 100
exclude = '''

(
  /(
      \.eggs         # exclude a few common directories in the
    | \.git          # root of the project
    | \.hg
    | \.mypy_cache
    | \.tox
    | \.venv
    | _build
    | buck-out
    | build
    | dist
  )/
)
'''

# Information needed for cibuildwheel
[tool.cibuildwheel]
# build options: https://cibuildwheel.readthedocs.io/en/stable/options/#build-selection
build = ["cp37-*", "cp38-*", "cp39-*", "cp310-*"]
skip = ["*-win32", "*i686", "*aarch64", "*ppc64le", "*s390x", "*musllinux*"]

# testing info: https://cibuildwheel.readthedocs.io/en/stable/options/#testing
test-command = "pytest {project}"
test-requires = ["pytest"]

# https://github.com/pypa/setuptools_scm/
# [tool.setuptools_scm]

[tool.coverage]
run.omit = ["testing/*", "*/*_test.py"]