Reduce requirements (#141)

Make `requests` and `click` optional requirements

Author: cthoyt

.readthedocs.yml

@@ -24,5 +24,5 @@ build:
     - asdf install uv latest
     - asdf global uv latest
     - uv venv $READTHEDOCS_VIRTUALENV_PATH
-    - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install .[docs,rdf,pandas,xml,aws,yaml,pydantic]
+    - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install .[docs,rdf,pandas,xml,aws,yaml,pydantic,requests,cli]
     - python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs/source $READTHEDOCS_OUTPUT/html

pyproject.toml

@@ -20,7 +20,6 @@ classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Framework :: Pytest",
     "Framework :: tox",
@@ -44,14 +43,10 @@ keywords = [
 
 # License Information.
 # See PEP-639 at https://peps.python.org/pep-0639/#add-license-files-key
-license-files = [
-    "LICENSE",
-]
+license = { file = "LICENSE" }
 
 requires-python = ">=3.10"
 dependencies = [
-    "click",
-    "requests",
     "tqdm",
     "typing-extensions",
 ]
@@ -60,7 +55,7 @@ dependencies = [
 tests = [
     "pytest",
     "coverage[toml]",
-    "requests_file",
+    "requests-file",
 ]
 typing = [
     "mypy",
@@ -69,39 +64,24 @@ typing = [
     "types-ratelimit",
     "types-PyYAML",
 ]
-
-[project.optional-dependencies]
-tests = [
-    "pytest",
-    "coverage[toml]",
-    "requests_file",
-]
 docs = [
     "sphinx>=8",
     "sphinx-rtd-theme>=3.0",
-    "sphinx-click", 
-    "sphinx_automodapi",
-]
-rdf = [
-    "rdflib",
-]
-xml = [
-    "lxml",
-]
-pandas = [
-    "pandas",
-]
-aws = [
-    "boto3",
-]
-ratelimit = [
-    "ratelimit",
-]
-bs4 = [
-    "bs4",
+    "sphinx-click",
+    "sphinx-automodapi",
 ]
+
+[project.optional-dependencies]
+rdf = ["rdflib"]
+xml = ["lxml"]
+pandas = ["pandas"]
+aws = ["boto3"]
+ratelimit = ["ratelimit", "requests"]
+bs4 = ["bs4"]
 yaml = ["pyyaml"]
 pydantic = ["pydantic"]
+cli = ["click"]
+requests = ["requests"]
 
 # See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#urls
 # and also https://packaging.python.org/en/latest/specifications/well-known-project-urls/

src/pystow/cli.py

@@ -1,13 +1,10 @@
-# -*- coding: utf-8 -*-
-# flake8: noqa
-# type: ignore
-
 """Command line interface for PyStow."""
 
 from __future__ import annotations
 
 import os
-from typing import Optional, Sequence
+from collections.abc import Sequence
+from pathlib import Path
 
 import click
 
@@ -20,7 +17,7 @@ def main() -> None:
 @main.command()
 @click.argument("keys", nargs=-1)
 @click.option("--name")
-def join(keys: Sequence[str], name: Optional[str]):
+def join(keys: Sequence[str], name: str | None) -> None:
     """List a directory."""
     from . import api
 
@@ -29,7 +26,7 @@ def join(keys: Sequence[str], name: Optional[str]):
 
 @main.command()
 @click.argument("keys", nargs=-1)
-def ls(keys: Sequence[str]):
+def ls(keys: Sequence[str]) -> None:
     """List a directory."""
     from . import api
 
@@ -42,15 +39,15 @@ def ls(keys: Sequence[str]):
 @click.option("--url", required=True)
 @click.option("--name")
 @click.option("--force", is_flag=True)
-def ensure(keys: Sequence[str], url: str, name: Optional[str], force: bool):
+def ensure(keys: Sequence[str], url: str, name: str | None, force: bool) -> None:
     """Ensure a file is downloaded."""
     from . import api
 
     path = api.ensure(*keys, url=url, name=name, force=force)
     _ls(path.parent)
 
 
-def _ls(directory):
+def _ls(directory: Path) -> None:
     command = f"ls -al {directory}"
     click.secho(f"[pystow] {command}", fg="cyan", bold=True)
     os.system(command)  # noqa:S605
@@ -60,7 +57,7 @@ def _ls(directory):
 @click.argument("module")
 @click.argument("key")
 @click.argument("value")
-def set_config(module: str, key: str, value: str):
+def set_config(module: str, key: str, value: str) -> None:
     """Set a configuration value."""
     from .config_api import write_config
 

src/pystow/github.py

@@ -4,15 +4,17 @@
 
 from collections.abc import Iterable
 from functools import partial
-from typing import Any, Literal, cast
+from typing import TYPE_CHECKING, Any, Literal, cast
 
-import requests
 from ratelimit import rate_limited
 from tqdm import tqdm
 
 from .config_api import get_config
 from .constants import TimeoutHint
 
+if TYPE_CHECKING:
+    import requests
+
 __all__ = [
     "MAXIMUM_SEARCH_PAGE_SIZE",
     "delete_branch",
@@ -81,6 +83,8 @@ def _request_github(
     **kwargs: Any,
 ) -> requests.Response:
     """Make a POST request to the GitHub API."""
+    import requests
+
     path = path.lstrip("/")
     url = f"https://api.github.com/{path}"
     headers = get_headers(token=token, raise_on_missing=require_token, preview=preview)

src/pystow/utils/download.py

@@ -11,7 +11,6 @@
 from typing import TYPE_CHECKING, Any, Literal, TypeAlias, TypedDict
 from urllib.request import urlretrieve
 
-import requests
 from tqdm import tqdm
 from typing_extensions import NotRequired, Unpack
 
@@ -20,6 +19,8 @@
 
 if TYPE_CHECKING:
     import botocore.client
+    import requests
+    import requests.exceptions
 
 __all__ = [
     "DownloadBackend",
@@ -158,6 +159,9 @@ def download(  # noqa:C901
                 except urllib.error.URLError as e:
                     raise DownloadError(backend, url, path, e) from e
         elif backend == "requests":
+            import requests
+            import requests.exceptions
+
             kwargs.setdefault("stream", True)
             try:
                 # see https://requests.readthedocs.io/en/master/user/quickstart/#raw-response-content
@@ -266,6 +270,8 @@ def download_from_google(
     :raises KeyboardInterrupt: If a keyboard interrupt is thrown during download
     :raises UnexpectedDirectory: If a directory is given for the ``path`` argument
     """
+    import requests
+
     path = Path(path).resolve()
 
     if path.is_dir():

src/pystow/utils/hashing.py

@@ -7,8 +7,7 @@
 from collections.abc import Collection, Iterable, Mapping
 from pathlib import Path
 from typing import NamedTuple, TypeAlias
-
-import requests
+from urllib.request import urlopen
 
 __all__ = [
     "Hash",
@@ -43,7 +42,8 @@ def get_hexdigests_remote(
     """
     rv = {}
     for key, url in (hexdigests_remote or {}).items():
-        text = requests.get(url, timeout=15).text
+        with urlopen(url) as response:  # noqa:S310
+            text = response.read().decode("utf-8")
         if not hexdigests_strict and "=" in text:
             text = text.rsplit("=", 1)[-1].strip()
         rv[key] = text

tox.ini

@@ -37,16 +37,19 @@ commands =
     coverage run -p -m pytest --durations=20 {posargs:tests}
     coverage combine
     coverage xml
-extras =
-    # See the [project.optional-dependencies] entry in pyproject.toml for "tests"
+dependency_groups =
     tests
+extras =
+    # See the [project.optional-dependencies] entry in pyproject.toml
     pandas
     rdf
     xml
     ratelimit
     bs4
     yaml
     pydantic
+    requests
+    cli
 
 [testenv:coverage-clean]
 description = Remove testing coverage artifacts.
@@ -113,6 +116,7 @@ commands =
 
 [testenv:pyroma]
 deps =
+    uv-build
     pygments
     pyroma
 skip_install = true
@@ -121,17 +125,19 @@ description = Run the pyroma tool to check the package friendliness of the proje
 
 [testenv:mypy]
 description = Run the mypy tool to check static typing on the project. Installs the package to make sure all type stubs get recognized.
-deps =
-    mypy
-    pydantic
-    types-requests
-    types-ratelimit
-    types-PyYAML
+dependency_groups =
+    typing
 extras =
+    # See the [project.optional-dependencies] entry in pyproject.toml
     pandas
     rdf
     xml
     ratelimit
+    bs4
+    yaml
+    pydantic
+    requests
+    cli
 commands = mypy --install-types --non-interactive --ignore-missing-imports --strict src/ tests/
 
 [testenv:doc8]
@@ -154,18 +160,16 @@ commands =
 
 [testenv:docs]
 description = Build the documentation locally, allowing warnings.
-extras =
-    # See the [project.optional-dependencies] entry in pyproject.toml for "docs"
+dependency_groups =
     docs
-    # You might need to add additional extras if your documentation covers it
 commands =
     python -m sphinx -b html -d docs/build/doctrees docs/source docs/build/html
 
 [testenv:docs-test]
 description = Test building the documentation in an isolated environment. Warnings are considered as errors via -W.
 changedir = docs
-extras =
-    {[testenv:docs]extras}
+dependency_groups =
+    {[testenv:docs]dependency_groups}
 commands =
     mkdir -p {envtmpdir}
     cp -r source {envtmpdir}/source