Skip to content

Commit

Permalink
MAINT: Update Pyproject Toml (And use setuptools to dynamically defin…
Browse files Browse the repository at this point in the history
…e the version)

The following changes have been made to the PyProject.toml

NEW:
-Added setuptools_scm to build system requires, and use it to dynamically define the EyeLinkIO Version number.

CRUFT:
- Removed Bandit table-header (We dont use bandit)
- Removed rstcheck table-hader (We dont use rst-check)
- Removed changelog-bot table-header (We dont have one)
- Removed reference to non-existent directory in the codespell table-header
  • Loading branch information
scott-huberty committed Dec 12, 2024
1 parent eded8e9 commit 3efb777
Showing 1 changed file with 13 additions and 65 deletions.
78 changes: 13 additions & 65 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
[build-system]
requires = ["setuptools >= 64.0.0"]
requires = ["setuptools >= 64.0.0", "setuptools-scm>=8"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
package-dir = {""= "src"}

# We use setuptools_scm to manage the EyeLinkIO version number
[tool.setuptools_scm]

[project]
name = "eyelinkio"
description = "A lightweight library for reading Eyelink Data Format files in Python."
maintainers = [{ name = "Scott Huberty", email = "seh33@uw.edu" }]
readme = "README.md"
requires-python = ">=3.9"
version = "0.2.0"
dynamic = ["version"]
keywords = [
"neuroscience",
"eyelink",
"eyetracking",
"SR Research",
]
classifiers = [
"Intended Audience :: Science/Research",
Expand Down Expand Up @@ -62,21 +66,19 @@ build = [
]
dev = ["eyelinkio[test,doc,build,full]"]

# [project.urls]
# Homepage = "https://mne.tools/"
# Download = "https://pypi.org/project/mne/#files"
# "Bug Tracker" = "https://github.com/mne-tools/mne-python/issues/"
# Documentation = "https://mne.tools/"
# Forum = "https://mne.discourse.group/"
# "Source Code" = "https://github.com/mne-tools/mne-python/"
[project.urls]
Homepage = "https://scott-huberty.github.io/eyelinkio/"
Download = "https://pypi.org/project/eyelinkio/#files"
"Bug Tracker" = "https://github.com/scott-huberty/eyelinkio/issues"
Documentation = "https://scott-huberty.github.io/eyelinkio/"
"Source Code" = "https://github.com/scott-huberty/eyelinkio"

[tool.codespell]
ignore-words = "ignore_words.txt"
builtin = "clear,rare,informal,names,usage"
skip = "doc/references.bib"

[tool.ruff]
exclude = ["__init__.py", "constants.py", "resources.py"]
exclude = ["__init__.py"]

[tool.ruff.lint]
select = ["A", "B006", "D", "E", "F", "I", "W", "UP"]
Expand Down Expand Up @@ -111,54 +113,6 @@ addopts = """--durations=20 --doctest-modules -rfEXs \
--color=yes --capture=sys"""
junit_family = "xunit2"

[tool.bandit.assert_used]
skips = ["*/test_*.py"] # assert statements are good practice with pytest

[tool.rstcheck]
report_level = "WARNING"
ignore_roles = [
"attr",
"class",
"doc",
"eq",
"exc",
"file",
"footcite",
"footcite:t",
"func",
"gh",
"kbd",
"meth",
"mod",
"newcontrib",
"py:mod",
"ref",
"samp",
"term",
]
ignore_directives = [
"autoclass",
"autofunction",
"automodule",
"autosummary",
"bibliography",
"cssclass",
"currentmodule",
"dropdown",
"footbibliography",
"glossary",
"graphviz",
"grid",
"highlight",
"minigallery",
"tabularcolumns",
"toctree",
"rst-class",
"tab-set",
"towncrier-draft-entries",
]
ignore_messages = "^.*(Unknown target name|Undefined substitution referenced)[^`]*$"

[tool.towncrier]
package = "eyelinkio"
directory = "docs/changes/devel/"
Expand Down Expand Up @@ -195,9 +149,3 @@ showcontent = true
directory = "other"
name = "Other changes"
showcontent = true

[tool.changelog-bot]
[tool.changelog-bot.towncrier_changelog]
enabled = true
verify_pr_number = true
changelog_skip_label = "no-changelog-entry-needed"

0 comments on commit 3efb777

Please sign in to comment.