figshare_client 0.0.2__tar.gz → 0.0.4__tar.gz

{figshare_client-0.0.2 → figshare_client-0.0.4}/PKG-INFO

@@ -1,34 +1,34 @@
 Metadata-Version: 2.4
 Name: figshare_client
-Version: 0.0.2
+Version: 0.0.4
 Summary: A client to Figshare
 Keywords: snekpack,cookiecutter,figshare
 Author: Charles Tapley Hoyt
 Author-email: Charles Tapley Hoyt <cthoyt@gmail.com>
+License-Expression: MIT
 License-File: LICENSE
 Classifier: Development Status :: 1 - Planning
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Framework :: Pytest
 Classifier: Framework :: tox
 Classifier: Framework :: Sphinx
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Typing :: Typed
 Requires-Dist: pydantic
 Requires-Dist: requests
-Requires-Dist: pystow
+Requires-Dist: pystow>=0.10.0
 Maintainer: Charles Tapley Hoyt
 Maintainer-email: Charles Tapley Hoyt <cthoyt@gmail.com>
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Project-URL: Bug Tracker, https://github.com/cthoyt/figshare-client/issues
 Project-URL: Homepage, https://github.com/cthoyt/figshare-client
 Project-URL: Repository, https://github.com/cthoyt/figshare-client.git

figshare_client-0.0.4/pyproject.toml

@@ -0,0 +1,230 @@
+[build-system]
+requires = ["uv_build>=0.9.6,<1.0"]
+build-backend = "uv_build"
+
+[project]
+name = "figshare_client"
+version = "0.0.4"
+description = "A client to Figshare"
+readme = "README.md"
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Framework :: Pytest",
+    "Framework :: tox",
+    "Framework :: Sphinx",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
+]
+keywords = [
+    "snekpack",
+    "cookiecutter",
+    "figshare",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = [
+    "pydantic",
+    "requests",
+    "pystow>=0.10.0",
+]
+
+[[project.authors]]
+name = "Charles Tapley Hoyt"
+email = "cthoyt@gmail.com"
+
+[[project.maintainers]]
+name = "Charles Tapley Hoyt"
+email = "cthoyt@gmail.com"
+
+[project.optional-dependencies]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/cthoyt/figshare-client/issues"
+Homepage = "https://github.com/cthoyt/figshare-client"
+Repository = "https://github.com/cthoyt/figshare-client.git"
+Documentation = "https://figshare_client.readthedocs.io"
+Funding = "https://github.com/sponsors/cthoyt"
+
+[project.scripts]
+figshare_client = "figshare_client.cli:main"
+
+[dependency-groups]
+tests = [
+    "pytest",
+    "coverage[toml]",
+]
+docs = [
+    "sphinx>=9",
+    "sphinx-rtd-theme>=3.0",
+    "sphinx-click",
+    "sphinx_automodapi",
+    "autodoc_pydantic",
+]
+lint = ["ruff"]
+typing = [
+    { include-group = "tests" },
+    "mypy",
+    "pydantic",
+    "types-click",
+    "types-requests",
+]
+docs-lint = [
+    { include-group = "docs" },
+    "doc8",
+]
+format-docs = [
+    { include-group = "docs" },
+    "docstrfmt",
+]
+doctests = [
+    "xdoctest",
+    "pygments",
+]
+pyroma = [
+    "pyroma",
+    "pygments",
+]
+
+[tool.cruft]
+skip = [
+    "**/__init__.py",
+    "tests/*",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.doc8]
+max-line-length = 120
+
+[tool.pytest.ini_options]
+markers = ["""slow: marks tests as slow (deselect with '-m "not slow"')"""]
+
+[tool.coverage.run]
+branch = true
+source = ["figshare_client"]
+omit = [
+    "tests/*",
+    "docs/*",
+    "src/figshare_client/version.py",
+    "src/figshare_client/__main__.py",
+    "src/figshare_client/cli.py",
+]
+
+[tool.coverage.paths]
+source = [
+    "src/figshare_client",
+    ".tox/*/lib/python*/site-packages/figshare_client",
+]
+
+[tool.coverage.report]
+show_missing = true
+exclude_lines = [
+    "pragma: no cover",
+    "raise NotImplementedError",
+    'if __name__ == "__main__":',
+    "if TYPE_CHECKING:",
+    "def __str__",
+    "def __repr__",
+]
+
+[tool.ruff]
+line-length = 100
+extend-include = ["*.ipynb"]
+
+[tool.ruff.lint]
+extend-select = [
+    "F",
+    "E",
+    "W",
+    "C90",
+    "I",
+    "UP",
+    "D",
+    "DOC",
+    "B",
+    "S",
+    "T20",
+    "N",
+    "ERA",
+    "NPY",
+    "RUF",
+    "C4",
+]
+ignore = [
+    "D105",
+    "E203",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"src/figshare_client/version.py" = [
+    "S603",
+    "S607",
+]
+"docs/source/conf.py" = ["ERA001"]
+"notebooks/**/*.ipynb" = ["T201"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.ruff.lint.isort]
+relative-imports-order = "closest-to-furthest"
+known-third-party = ["tqdm"]
+known-first-party = [
+    "figshare_client",
+    "tests",
+]
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.bumpversion]
+current_version = "0.0.4"
+parse = '(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<release>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+(?P<build>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?'
+serialize = [
+    "{major}.{minor}.{patch}-{release}+{build}",
+    "{major}.{minor}.{patch}+{build}",
+    "{major}.{minor}.{patch}-{release}",
+    "{major}.{minor}.{patch}",
+]
+commit = true
+tag = false
+
+[tool.bumpversion.parts.release]
+optional_value = "production"
+first_value = "dev"
+values = [
+    "dev",
+    "production",
+]
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "docs/source/conf.py"
+search = 'release = "{current_version}"'
+replace = 'release = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "src/figshare_client/version.py"
+search = 'VERSION = "{current_version}"'
+replace = 'VERSION = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "CITATION.cff"
+search = "version: {current_version}"
+replace = "version: {new_version}"

figshare_client-0.0.2/pyproject.toml → figshare_client-0.0.4/pyproject.toml.orig

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "figshare_client"
-version = "0.0.2"
+version = "0.0.4"
 description = "A client to Figshare"
 readme = "README.md"
 authors = [
@@ -20,21 +20,19 @@ classifiers = [
     "Development Status :: 1 - Planning",
     "Environment :: Console",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Framework :: Pytest",
     "Framework :: tox",
     "Framework :: Sphinx",
     "Natural Language :: English",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Programming Language :: Python :: 3 :: Only",
     "Typing :: Typed",
-    # TODO add your topics from the Trove controlled vocabulary (see https://pypi.org/classifiers)
 ]
 keywords = [
     "snekpack", # please keep this keyword to credit the cookiecutter-snekpack template
@@ -44,15 +42,16 @@ keywords = [
 
 # License Information.
 # See PEP-639 at https://peps.python.org/pep-0639/#add-license-files-key
+license = "MIT"
 license-files = [
     "LICENSE",
 ]
 
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dependencies = [
     "pydantic",
     "requests",
-    "pystow",
+    "pystow>=0.10.0",
 ]
 
 # see https://peps.python.org/pep-0735/ and https://docs.astral.sh/uv/concepts/dependencies/#dependency-groups
@@ -62,7 +61,7 @@ tests = [
     "coverage[toml]",
 ]
 docs = [
-    "sphinx>=8,<9",
+    "sphinx>=9",
     "sphinx-rtd-theme>=3.0",
     "sphinx-click",
     "sphinx_automodapi",
@@ -220,7 +219,7 @@ known-first-party = [
 docstring-code-format = true
 
 [tool.bumpversion]
-current_version = "0.0.2"
+current_version = "0.0.4"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(?:-(?P<release>[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+(?P<build>[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?"
 serialize = [
     "{major}.{minor}.{patch}-{release}+{build}",

{figshare_client-0.0.2 → figshare_client-0.0.4}/src/figshare_client/api.py

@@ -1,6 +1,7 @@
 """Interact with the Figshare API."""
 
 from pathlib import Path
+from typing import Any
 
 import pystow
 import requests
@@ -39,7 +40,9 @@ def get_files(record_id: int) -> list[File]:
     return [File.model_validate(f) for f in res.json()]
 
 
-def ensure_files(record_id: int, *, concurrent: bool = True) -> dict[Path, File]:
+def ensure_files(
+    record_id: int, *, concurrent: bool = True, tqdm_kwargs: dict[str, Any] | None = None
+) -> dict[Path, File]:
     """Ensure all files for a record."""
     files = get_files(record_id)
     submodule = MODULE.module(str(record_id))
@@ -47,7 +50,15 @@ def ensure_files(record_id: int, *, concurrent: bool = True) -> dict[Path, File]
     def _func(file: File) -> tuple[Path, File]:
         return submodule.ensure(url=str(file.download_url), name=file.name), file
 
+    _tqdm_kwargs = {
+        "desc": f"downloading figshare:{record_id}",
+        "unit": "file",
+        "leave": False,
+    }
+    if tqdm_kwargs:
+        _tqdm_kwargs.update(tqdm_kwargs)
+
     if concurrent:
-        return dict(thread_map(_func, files))
+        return dict(thread_map(_func, files, **_tqdm_kwargs))
     else:
-        return dict(tmap(_func, files))
+        return dict(tmap(_func, files, **_tqdm_kwargs))

{figshare_client-0.0.2 → figshare_client-0.0.4}/src/figshare_client/version.py

@@ -12,7 +12,7 @@ __all__ = [
     "get_version",
 ]
 
-VERSION = "0.0.2"
+VERSION = "0.0.4"
 
 
 def get_git_hash() -> str: