pyproject.toml

[build-system]
requires = ["hatchling", "hatch-requirements-txt"]
build-backend = "hatchling.build"


[project]
name = "oauthenticator"
version = "17.5.0.dev0"
description = "OAuthenticator: Authenticate JupyterHub users with common OAuth providers"
readme = "README.md"
license = "BSD-3-Clause"
requires-python = ">=3.10"
authors = [
    {name = "Jupyter Development Team", email = "jupyter@googlegroups.com"},
]
classifiers = [
    "Intended Audience :: Developers",
    "Intended Audience :: System Administrators",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: BSD License",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
]
dynamic = ["dependencies"]

[tool.hatch.metadata.hooks.requirements_txt]
files = ["requirements.txt"]

[project.optional-dependencies]
# googlegroups is required for use of GoogleOAuthenticator configured with
# either admin_google_groups and/or allowed_google_groups.
googlegroups = [
    "google-auth-oauthlib",
]
# mediawiki is required for use of MWOAuthenticator
mediawiki = [
    "mwoauth>=0.3.8",
]
# test is required to run tests, and includes all authenticator specific
# dependencies above.
test = [
    "pytest>=6",
    "pytest-asyncio>=1.2",
    "pytest-cov",
    "requests-mock",
    # dependencies from googlegroups:
    "google-auth-oauthlib",
    # dependencies from mediawiki:
    "mwoauth>=0.3.8",
]

[project.entry-points."jupyterhub.authenticators"]
auth0 = "oauthenticator.auth0:Auth0OAuthenticator"
local-auth0 = "oauthenticator.auth0:LocalAuth0OAuthenticator"
azuread = "oauthenticator.azuread:AzureAdOAuthenticator"
local-azuread = "oauthenticator.azuread:LocalAzureAdOAuthenticator"
bitbucket = "oauthenticator.bitbucket:BitbucketOAuthenticator"
local-bitbucket = "oauthenticator.bitbucket:LocalBitbucketOAuthenticator"
cilogon = "oauthenticator.cilogon:CILogonOAuthenticator"
local-cilogon = "oauthenticator.cilogon:LocalCILogonOAuthenticator"
generic-oauth = "oauthenticator.generic:GenericOAuthenticator"
local-generic-oauth = "oauthenticator.generic:LocalGenericOAuthenticator"
github = "oauthenticator.github:GitHubOAuthenticator"
local-github = "oauthenticator.github:LocalGitHubOAuthenticator"
gitlab = "oauthenticator.gitlab:GitLabOAuthenticator"
local-gitlab = "oauthenticator.gitlab:LocalGitLabOAuthenticator"
globus = "oauthenticator.globus:GlobusOAuthenticator"
local-globus = "oauthenticator.globus:LocalGlobusOAuthenticator"
google = "oauthenticator.google:GoogleOAuthenticator"
local-google = "oauthenticator.google:LocalGoogleOAuthenticator"
mediawiki = "oauthenticator.mediawiki:MWOAuthenticator"
openshift = "oauthenticator.openshift:OpenShiftOAuthenticator"
local-openshift = "oauthenticator.openshift:LocalOpenShiftOAuthenticator"

[project.urls]
Homepage = "https://jupyter.org"
Source = "https://github.com/jupyterhub/oauthenticator"


# autoflake is used for autoformatting Python code
#
# ref: https://github.com/PyCQA/autoflake#readme
#
[tool.autoflake]
ignore-init-module-imports = true
remove-all-unused-imports = true
remove-duplicate-keys = true
#remove-unused-variables = true


# isort is used for autoformatting Python code
#
# ref: https://pycqa.github.io/isort/
#
[tool.isort]
profile = "black"


# black is used for autoformatting Python code
#
# ref: https://black.readthedocs.io/en/stable/
#
[tool.black]
skip-string-normalization = true


# pytest is used for running Python based tests
#
# ref: https://docs.pytest.org/en/stable/
#
[tool.pytest.ini_options]
addopts = "--verbose --color=yes --durations=10 --cov=oauthenticator"
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"
testpaths = [
    "oauthenticator/tests"
]


# pytest-cov / coverage is used to measure code coverage of tests
#
# ref: https://coverage.readthedocs.io/en/stable/config.html
#
[tool.coverage.run]
omit = [
  "oauthenticator/tests/**",
]


# tbump is used to simplify and standardize the release process when updating
# the version, making a git commit and tag, and pushing changes.
#
# ref: https://github.com/your-tools/tbump#readme
#
[tool.tbump]
github_url = "https://github.com/jupyterhub/oauthenticator"

[tool.tbump.version]
current = "17.5.0.dev0"
regex = '''
    (?P<major>\d+)
    \.
    (?P<minor>\d+)
    \.
    (?P<patch>\d+)
    (?P<pre>((a|b|rc)\d+)|)
    \.?
    (?P<dev>(?<=\.)dev\d*|)
'''

[tool.tbump.git]
message_template = "Bump to {new_version}"
tag_template = "{new_version}"

[[tool.tbump.file]]
src = "pyproject.toml"

[[tool.tbump.file]]
src = "oauthenticator/_version.py"