Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pyproject.toml #204

Merged
merged 9 commits into from
Feb 29, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 40 additions & 21 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# Specification of pyproject.toml:
# https://packaging.python.org/en/latest/guides/writing-pyproject-toml/

# Should pyproject.toml be added?
# A pyproject.toml file is strongly recommended. The presence of a pyproject.toml
# file itself does not bring much. What is actually strongly recommended is the
VladimirFokow marked this conversation as resolved.
Show resolved Hide resolved
# [build-system] table in pyproject.toml.
# https://packaging.python.org/en/latest/guides/modernize-setup-py-project/#should-pyproject-toml-be-added

# Choosing a build backend:
# https://packaging.python.org/en/latest/tutorials/packaging-projects/#choosing-a-build-backend
[build-system]
# Both of these values will be provided by the documentation for your build backend,
# or generated by its command line interface.
# Usually, you’ll just copy what your build backend’s documentation suggests.
# There should be no need for you to customize these settings.
#
# A list of packages that are needed to build your package:
requires = ["setuptools"] # REQUIRED if [build-system] table is used
# The name of the Python object that frontends will use to perform the build.
# If not defined, then the fall-back behaviour is to use setuptools.
VladimirFokow marked this conversation as resolved.
Show resolved Hide resolved
build-backend = "setuptools.build_meta"


[project]
# This is the name of your project. The first time you publish this
# package, this name will be registered for you. It will determine how
Expand All @@ -10,32 +34,32 @@
# There are some restrictions on what makes a valid project name
# specification here:
# https://packaging.python.org/specifications/core-metadata/#name
name = "sampleproject" # Required
name = "sampleproject" # REQUIRED, is the only field that cannot be marked as dynamic.

# Versions should comply with PEP 440:
# https://www.python.org/dev/peps/pep-0440/
#
# For a discussion on single-sourcing the version, see
# https://packaging.python.org/guides/single-sourcing-package-version/
version = "3.0.0" # Required
version = "3.0.0" # REQUIRED, although can be dynamic

# This is a one-line description or tagline of what your project does. This
# corresponds to the "Summary" metadata field:
# https://packaging.python.org/specifications/core-metadata/#summary
description = "A sample Python project" # Optional
VladimirFokow marked this conversation as resolved.
Show resolved Hide resolved
description = "A sample Python project"

# This is an optional longer description of your project that represents
# the body of text which users will see when they visit PyPI.
#
# Often, this is the same as your README, so you can just read it in from
# that file directly (as we have already done above)
# that file directly.
#
# This field corresponds to the "Description" metadata field:
# https://packaging.python.org/specifications/core-metadata/#description-optional
readme = "README.md" # Optional
VladimirFokow marked this conversation as resolved.
Show resolved Hide resolved
readme = "README.md"

# Specify which Python versions you support. In contrast to the
# 'Programming Language' classifiers above, 'pip install' will check this
# 'Programming Language' classifiers in this file, 'pip install' will check this
# and refuse to install the project if the version does not match. See
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
requires-python = ">=3.7"
Expand All @@ -51,26 +75,26 @@ license = {file = "LICENSE.txt"}
# Note that this is a list of additional keywords, separated
# by commas, to be used to assist searching for the distribution in a
# larger catalog.
keywords = ["sample", "setuptools", "development"] # Optional
keywords = ["sample", "setuptools", "development"]

# This should be your name or the name of the organization who originally
# authored the project, and a valid email address corresponding to the name
# listed.
authors = [
{name = "A. Random Developer", email = "[email protected]" } # Optional
{name = "A. Random Developer", email = "[email protected]" }
]

# This should be your name or the names of the organization who currently
# maintains the project, and a valid email address corresponding to the name
# listed.
maintainers = [
{name = "A. Great Maintainer", email = "[email protected]" } # Optional
{name = "A. Great Maintainer", email = "[email protected]" }
]

# Classifiers help users find your project by categorizing it.
#
# For a list of valid classifiers, see https://pypi.org/classifiers/
classifiers = [ # Optional
classifiers = [
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
Expand All @@ -86,7 +110,7 @@ classifiers = [ # Optional

# Specify the Python versions you support here. In particular, ensure
# that you indicate you support Python 3. These classifiers are *not*
# checked by "pip install". See instead "python_requires" below.
# checked by "pip install". See instead "requires-python" key in this file.
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
Expand All @@ -102,7 +126,7 @@ classifiers = [ # Optional
#
# For an analysis of this field vs pip's requirements files see:
# https://packaging.python.org/discussions/install-requires-vs-requirements/
dependencies = [ # Optional
dependencies = [
"peppercorn"
]

Expand All @@ -114,7 +138,7 @@ dependencies = [ # Optional
#
# Similar to `dependencies` above, these must be valid existing
# projects.
VladimirFokow marked this conversation as resolved.
Show resolved Hide resolved
[project.optional-dependencies] # Optional
[project.optional-dependencies]
dev = ["check-manifest"]
test = ["coverage"]

Expand All @@ -128,7 +152,7 @@ test = ["coverage"]
# issues, where the source is hosted, where to say thanks to the package
# maintainers, and where to support the project financially. The key is
# what's used to render the link text on PyPI.
[project.urls] # Optional
[project.urls]
"Homepage" = "https://github.com/pypa/sampleproject"
"Bug Reports" = "https://github.com/pypa/sampleproject/issues"
"Funding" = "https://donate.pypi.org"
Expand All @@ -137,18 +161,13 @@ test = ["coverage"]

# The following would provide a command line executable called `sample`
# which executes the function `main` from this package when invoked.
[project.scripts] # Optional
[project.scripts]
sample = "sample:main"


# This is configuration specific to the `setuptools` build backend.
# If you are using a different build backend, you will need to change this.
[tool.setuptools]
# If there are data files included in your packages that need to be
# installed, specify them here.
package-data = {"sample" = ["*.dat"]}

[build-system]
# These are the assumed default build requirements from pip:
# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
requires = ["setuptools>=43.0.0", "wheel"]
build-backend = "setuptools.build_meta"