figshare_client 0.0.1__tar.gz

figshare_client-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Charles Tapley Hoyt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

figshare_client-0.0.1/PKG-INFO

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: figshare_client
+Version: 0.0.1
+Summary: A client to Figshare
+Keywords: snekpack,cookiecutter,figshare
+Author: Charles Tapley Hoyt
+Author-email: Charles Tapley Hoyt <cthoyt@gmail.com>
+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 :: Only
+Classifier: Typing :: Typed
+Requires-Dist: pydantic
+Requires-Dist: requests
+Requires-Dist: pystow
+Maintainer: Charles Tapley Hoyt
+Maintainer-email: Charles Tapley Hoyt <cthoyt@gmail.com>
+Requires-Python: >=3.10
+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
+Project-URL: Documentation, https://figshare_client.readthedocs.io
+Project-URL: Funding, https://github.com/sponsors/cthoyt
+Description-Content-Type: text/markdown
+
+<!--
+<p align="center">
+  <img src="https://github.com/cthoyt/figshare-client/raw/main/docs/source/logo.png" height="150">
+</p>
+-->
+
+<h1 align="center">
+  Figshare Client
+</h1>
+
+<p align="center">
+    <a href="https://github.com/cthoyt/figshare-client/actions/workflows/tests.yml">
+        <img alt="Tests" src="https://github.com/cthoyt/figshare-client/actions/workflows/tests.yml/badge.svg" /></a>
+    <a href="https://pypi.org/project/figshare_client">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/figshare_client" /></a>
+    <a href="https://pypi.org/project/figshare_client">
+        <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/figshare_client" /></a>
+    <a href="https://github.com/cthoyt/figshare-client/blob/main/LICENSE">
+        <img alt="PyPI - License" src="https://img.shields.io/pypi/l/figshare_client" /></a>
+    <a href='https://figshare_client.readthedocs.io/en/latest/?badge=latest'>
+        <img src='https://readthedocs.org/projects/figshare_client/badge/?version=latest' alt='Documentation Status' /></a>
+    <a href="https://codecov.io/gh/cthoyt/figshare-client/branch/main">
+        <img src="https://codecov.io/gh/cthoyt/figshare-client/branch/main/graph/badge.svg" alt="Codecov status" /></a>  
+    <a href="https://github.com/cthoyt/cookiecutter-python-package">
+        <img alt="Cookiecutter template from @cthoyt" src="https://img.shields.io/badge/Cookiecutter-snekpack-blue" /></a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;"></a>
+    <a href="https://github.com/cthoyt/figshare-client/blob/main/.github/CODE_OF_CONDUCT.md">
+        <img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"/></a>
+    <!-- uncomment if you archive on zenodo
+    <a href="https://zenodo.org/badge/latestdoi/XXXXXX">
+        <img src="https://zenodo.org/badge/XXXXXX.svg" alt="DOI"></a>
+    -->
+</p>
+
+A client to Figshare.
+
+## 💪 Getting Started
+
+```python
+from figshare_client import get_files, ensure_files
+
+opencitations_record_id = 24356626
+
+# get objects describing files
+infos = get_files(opencitations_record_id)
+
+# download files locally
+path_to_info = ensure_files(opencitations_record_id)
+```
+
+### Command Line Interface
+
+The `figshare_client` command line tool is automatically installed. It can be
+used from the console with the `--help` flag to show all subcommands:
+
+```console
+$ figshare_client --help
+```
+
+> TODO show the most useful thing the CLI does! The CLI will have documentation
+> auto-generated by `sphinx`.
+
+## 🚀 Installation
+
+<!-- Uncomment this section after your first ``tox -e finish``
+The most recent release can be installed from
+[PyPI](https://pypi.org/project/figshare_client/) with uv:
+
+```console
+$ uv pip install figshare_client
+```
+
+or with pip:
+
+```console
+$ python3 -m pip install figshare_client
+```
+-->
+
+The most recent code and data can be installed directly from GitHub with uv:
+
+```console
+$ uv pip install git+https://github.com/cthoyt/figshare-client.git
+```
+
+or with pip:
+
+```console
+$ python3 -m pip install git+https://github.com/cthoyt/figshare-client.git
+```
+
+## 👐 Contributing
+
+Contributions, whether filing an issue, making a pull request, or forking, are
+appreciated. See
+[CONTRIBUTING.md](https://github.com/cthoyt/figshare-client/blob/master/.github/CONTRIBUTING.md)
+for more information on getting involved.
+
+## 👋 Attribution
+
+### ⚖️ License
+
+The code in this package is licensed under the MIT License.
+
+<!--
+### 📖 Citation
+
+Citation goes here!
+-->
+
+<!--
+### 🎁 Support
+
+This project has been supported by the following organizations (in alphabetical order):
+
+- [Biopragmatics Lab](https://biopragmatics.github.io)
+
+-->
+
+<!--
+### 💰 Funding
+
+This project has been supported by the following grants:
+
+| Funding Body  | Program                                                      | Grant Number |
+|---------------|--------------------------------------------------------------|--------------|
+| Funder        | [Grant Name (GRANT-ACRONYM)](https://example.com/grant-link) | ABCXYZ       |
+-->
+
+### 🍪 Cookiecutter
+
+This package was created with
+[@audreyfeldroy](https://github.com/audreyfeldroy)'s
+[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using
+[@cthoyt](https://github.com/cthoyt)'s
+[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
+template.
+
+## 🛠️ For Developers
+
+<details>
+  <summary>See developer instructions</summary>
+
+The final section of the README is for if you want to get involved by making a
+code contribution.
+
+### Development Installation
+
+To install in development mode, use the following:
+
+```console
+$ git clone git+https://github.com/cthoyt/figshare-client.git
+$ cd figshare-client
+$ uv pip install -e .
+```
+
+Alternatively, install using pip:
+
+```console
+$ python3 -m pip install -e .
+```
+
+### Pre-commit
+
+You can optionally use [pre-commit](https://pre-commit.com) to automate running
+key code quality checks on each commit. Enable it with:
+
+```console
+$ uvx pre-commit install
+```
+
+Or using `pip`:
+
+```console
+$ pip install pre-commit
+$ pre-commit install
+```
+
+### 🥼 Testing
+
+After cloning the repository and installing `tox` with
+`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, the
+unit tests in the `tests/` folder can be run reproducibly with:
+
+```console
+$ tox -e py
+```
+
+Additionally, these tests are automatically re-run with each commit in a
+[GitHub Action](https://github.com/cthoyt/figshare-client/actions?query=workflow%3ATests).
+
+### 📖 Building the Documentation
+
+The documentation can be built locally using the following:
+
+```console
+$ git clone git+https://github.com/cthoyt/figshare-client.git
+$ cd figshare-client
+$ tox -e docs
+$ open docs/build/html/index.html
+```
+
+The documentation automatically installs the package as well as the `docs` extra
+specified in the [`pyproject.toml`](pyproject.toml). `sphinx` plugins like
+`texext` can be added there. Additionally, they need to be added to the
+`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).
+
+The documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using
+[this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html). The
+[`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration
+you'll need. You can also set up continuous integration on GitHub to check not
+only that Sphinx can build the documentation in an isolated environment (i.e.,
+with `tox -e docs-test`) but also that
+[ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html).
+
+</details>
+
+## 🧑‍💻 For Maintainers
+
+<details>
+  <summary>See maintainer instructions</summary>
+
+### Initial Configuration
+
+#### Configuring ReadTheDocs
+
+[ReadTheDocs](https://readthedocs.org) is an external documentation hosting
+service that integrates with GitHub's CI/CD. Do the following for each
+repository:
+
+1. Log in to ReadTheDocs with your GitHub account to install the integration at
+   https://readthedocs.org/accounts/login/?next=/dashboard/
+2. Import your project by navigating to https://readthedocs.org/dashboard/import
+   then clicking the plus icon next to your repository
+3. You can rename the repository on the next screen using a more stylized name
+   (i.e., with spaces and capital letters)
+4. Click next, and you're good to go!
+
+#### Configuring Archival on Zenodo
+
+[Zenodo](https://zenodo.org) is a long-term archival system that assigns a DOI
+to each release of your package. Do the following for each repository:
+
+1. Log in to Zenodo via GitHub with this link:
+   https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page
+   that lists all of your organizations and asks you to approve installing the
+   Zenodo app on GitHub. Click "grant" next to any organizations you want to
+   enable the integration for, then click the big green "approve" button. This
+   step only needs to be done once.
+2. Navigate to https://zenodo.org/account/settings/github/, which lists all of
+   your GitHub repositories (both in your username and any organizations you
+   enabled). Click the on/off toggle for any relevant repositories. When you
+   make a new repository, you'll have to come back to this
+
+After these steps, you're ready to go! After you make "release" on GitHub (steps
+for this are below), you can navigate to
+https://zenodo.org/account/settings/github/repository/cthoyt/figshare-client to
+see the DOI for the release and link to the Zenodo record for it.
+
+#### Registering with the Python Package Index (PyPI)
+
+The [Python Package Index (PyPI)](https://pypi.org) hosts packages so they can
+be easily installed with `pip`, `uv`, and equivalent tools.
+
+1. Register for an account [here](https://pypi.org/account/register)
+2. Navigate to https://pypi.org/manage/account and make sure you have verified
+   your email address. A verification email might not have been sent by default,
+   so you might have to click the "options" dropdown next to your address to get
+   to the "re-send verification email" button
+3. 2-Factor authentication is required for PyPI since the end of 2023 (see this
+   [blog post from PyPI](https://blog.pypi.org/posts/2023-05-25-securing-pypi-with-2fa/)).
+   This means you have to first issue account recovery codes, then set up
+   2-factor authentication
+4. Issue an API token from https://pypi.org/manage/account/token
+
+This only needs to be done once per developer.
+
+#### Configuring your machine's connection to PyPI
+
+This needs to be done once per machine.
+
+```console
+$ uv tool install keyring
+$ keyring set https://upload.pypi.org/legacy/ __token__
+$ keyring set https://test.pypi.org/legacy/ __token__
+```
+
+Note that this deprecates previous workflows using `.pypirc`.
+
+### 📦 Making a Release
+
+#### Uploading to PyPI
+
+After installing the package in development mode and installing `tox` with
+`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, run
+the following from the console:
+
+```console
+$ tox -e finish
+```
+
+This script does the following:
+
+1. Uses [bump-my-version](https://github.com/callowayproject/bump-my-version) to
+   switch the version number in the `pyproject.toml`, `CITATION.cff`,
+   `src/figshare_client/version.py`, and
+   [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix
+2. Packages the code in both a tar archive and a wheel using
+   [`uv build`](https://docs.astral.sh/uv/guides/publish/#building-your-package)
+3. Uploads to PyPI using
+   [`uv publish`](https://docs.astral.sh/uv/guides/publish/#publishing-your-package).
+4. Push to GitHub. You'll need to make a release going with the commit where the
+   version was bumped.
+5. Bump the version to the next patch. If you made big changes and want to bump
+   the version by minor, you can use `tox -e bumpversion -- minor` after.
+
+#### Releasing on GitHub
+
+1. Navigate to https://github.com/cthoyt/figshare-client/releases/new to draft a
+   new release
+2. Click the "Choose a Tag" dropdown and select the tag corresponding to the
+   release you just made
+3. Click the "Generate Release Notes" button to get a quick outline of recent
+   changes. Modify the title and description as you see fit
+4. Click the big green "Publish Release" button
+
+This will trigger Zenodo to assign a DOI to your release as well.
+
+### Updating Package Boilerplate
+
+This project uses `cruft` to keep boilerplate (i.e., configuration, contribution
+guidelines, documentation configuration) up-to-date with the upstream
+cookiecutter package. Install cruft with either `uv tool install cruft` or
+`python3 -m pip install cruft` then run:
+
+```console
+$ cruft update
+```
+
+More info on Cruft's update command is available
+[here](https://github.com/cruft/cruft?tab=readme-ov-file#updating-a-project).
+
+</details>

figshare_client-0.0.1/README.md

@@ -0,0 +1,344 @@
+<!--
+<p align="center">
+  <img src="https://github.com/cthoyt/figshare-client/raw/main/docs/source/logo.png" height="150">
+</p>
+-->
+
+<h1 align="center">
+  Figshare Client
+</h1>
+
+<p align="center">
+    <a href="https://github.com/cthoyt/figshare-client/actions/workflows/tests.yml">
+        <img alt="Tests" src="https://github.com/cthoyt/figshare-client/actions/workflows/tests.yml/badge.svg" /></a>
+    <a href="https://pypi.org/project/figshare_client">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/figshare_client" /></a>
+    <a href="https://pypi.org/project/figshare_client">
+        <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/figshare_client" /></a>
+    <a href="https://github.com/cthoyt/figshare-client/blob/main/LICENSE">
+        <img alt="PyPI - License" src="https://img.shields.io/pypi/l/figshare_client" /></a>
+    <a href='https://figshare_client.readthedocs.io/en/latest/?badge=latest'>
+        <img src='https://readthedocs.org/projects/figshare_client/badge/?version=latest' alt='Documentation Status' /></a>
+    <a href="https://codecov.io/gh/cthoyt/figshare-client/branch/main">
+        <img src="https://codecov.io/gh/cthoyt/figshare-client/branch/main/graph/badge.svg" alt="Codecov status" /></a>  
+    <a href="https://github.com/cthoyt/cookiecutter-python-package">
+        <img alt="Cookiecutter template from @cthoyt" src="https://img.shields.io/badge/Cookiecutter-snekpack-blue" /></a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;"></a>
+    <a href="https://github.com/cthoyt/figshare-client/blob/main/.github/CODE_OF_CONDUCT.md">
+        <img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"/></a>
+    <!-- uncomment if you archive on zenodo
+    <a href="https://zenodo.org/badge/latestdoi/XXXXXX">
+        <img src="https://zenodo.org/badge/XXXXXX.svg" alt="DOI"></a>
+    -->
+</p>
+
+A client to Figshare.
+
+## 💪 Getting Started
+
+```python
+from figshare_client import get_files, ensure_files
+
+opencitations_record_id = 24356626
+
+# get objects describing files
+infos = get_files(opencitations_record_id)
+
+# download files locally
+path_to_info = ensure_files(opencitations_record_id)
+```
+
+### Command Line Interface
+
+The `figshare_client` command line tool is automatically installed. It can be
+used from the console with the `--help` flag to show all subcommands:
+
+```console
+$ figshare_client --help
+```
+
+> TODO show the most useful thing the CLI does! The CLI will have documentation
+> auto-generated by `sphinx`.
+
+## 🚀 Installation
+
+<!-- Uncomment this section after your first ``tox -e finish``
+The most recent release can be installed from
+[PyPI](https://pypi.org/project/figshare_client/) with uv:
+
+```console
+$ uv pip install figshare_client
+```
+
+or with pip:
+
+```console
+$ python3 -m pip install figshare_client
+```
+-->
+
+The most recent code and data can be installed directly from GitHub with uv:
+
+```console
+$ uv pip install git+https://github.com/cthoyt/figshare-client.git
+```
+
+or with pip:
+
+```console
+$ python3 -m pip install git+https://github.com/cthoyt/figshare-client.git
+```
+
+## 👐 Contributing
+
+Contributions, whether filing an issue, making a pull request, or forking, are
+appreciated. See
+[CONTRIBUTING.md](https://github.com/cthoyt/figshare-client/blob/master/.github/CONTRIBUTING.md)
+for more information on getting involved.
+
+## 👋 Attribution
+
+### ⚖️ License
+
+The code in this package is licensed under the MIT License.
+
+<!--
+### 📖 Citation
+
+Citation goes here!
+-->
+
+<!--
+### 🎁 Support
+
+This project has been supported by the following organizations (in alphabetical order):
+
+- [Biopragmatics Lab](https://biopragmatics.github.io)
+
+-->
+
+<!--
+### 💰 Funding
+
+This project has been supported by the following grants:
+
+| Funding Body  | Program                                                      | Grant Number |
+|---------------|--------------------------------------------------------------|--------------|
+| Funder        | [Grant Name (GRANT-ACRONYM)](https://example.com/grant-link) | ABCXYZ       |
+-->
+
+### 🍪 Cookiecutter
+
+This package was created with
+[@audreyfeldroy](https://github.com/audreyfeldroy)'s
+[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using
+[@cthoyt](https://github.com/cthoyt)'s
+[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
+template.
+
+## 🛠️ For Developers
+
+<details>
+  <summary>See developer instructions</summary>
+
+The final section of the README is for if you want to get involved by making a
+code contribution.
+
+### Development Installation
+
+To install in development mode, use the following:
+
+```console
+$ git clone git+https://github.com/cthoyt/figshare-client.git
+$ cd figshare-client
+$ uv pip install -e .
+```
+
+Alternatively, install using pip:
+
+```console
+$ python3 -m pip install -e .
+```
+
+### Pre-commit
+
+You can optionally use [pre-commit](https://pre-commit.com) to automate running
+key code quality checks on each commit. Enable it with:
+
+```console
+$ uvx pre-commit install
+```
+
+Or using `pip`:
+
+```console
+$ pip install pre-commit
+$ pre-commit install
+```
+
+### 🥼 Testing
+
+After cloning the repository and installing `tox` with
+`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, the
+unit tests in the `tests/` folder can be run reproducibly with:
+
+```console
+$ tox -e py
+```
+
+Additionally, these tests are automatically re-run with each commit in a
+[GitHub Action](https://github.com/cthoyt/figshare-client/actions?query=workflow%3ATests).
+
+### 📖 Building the Documentation
+
+The documentation can be built locally using the following:
+
+```console
+$ git clone git+https://github.com/cthoyt/figshare-client.git
+$ cd figshare-client
+$ tox -e docs
+$ open docs/build/html/index.html
+```
+
+The documentation automatically installs the package as well as the `docs` extra
+specified in the [`pyproject.toml`](pyproject.toml). `sphinx` plugins like
+`texext` can be added there. Additionally, they need to be added to the
+`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).
+
+The documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using
+[this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html). The
+[`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration
+you'll need. You can also set up continuous integration on GitHub to check not
+only that Sphinx can build the documentation in an isolated environment (i.e.,
+with `tox -e docs-test`) but also that
+[ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html).
+
+</details>
+
+## 🧑‍💻 For Maintainers
+
+<details>
+  <summary>See maintainer instructions</summary>
+
+### Initial Configuration
+
+#### Configuring ReadTheDocs
+
+[ReadTheDocs](https://readthedocs.org) is an external documentation hosting
+service that integrates with GitHub's CI/CD. Do the following for each
+repository:
+
+1. Log in to ReadTheDocs with your GitHub account to install the integration at
+   https://readthedocs.org/accounts/login/?next=/dashboard/
+2. Import your project by navigating to https://readthedocs.org/dashboard/import
+   then clicking the plus icon next to your repository
+3. You can rename the repository on the next screen using a more stylized name
+   (i.e., with spaces and capital letters)
+4. Click next, and you're good to go!
+
+#### Configuring Archival on Zenodo
+
+[Zenodo](https://zenodo.org) is a long-term archival system that assigns a DOI
+to each release of your package. Do the following for each repository:
+
+1. Log in to Zenodo via GitHub with this link:
+   https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page
+   that lists all of your organizations and asks you to approve installing the
+   Zenodo app on GitHub. Click "grant" next to any organizations you want to
+   enable the integration for, then click the big green "approve" button. This
+   step only needs to be done once.
+2. Navigate to https://zenodo.org/account/settings/github/, which lists all of
+   your GitHub repositories (both in your username and any organizations you
+   enabled). Click the on/off toggle for any relevant repositories. When you
+   make a new repository, you'll have to come back to this
+
+After these steps, you're ready to go! After you make "release" on GitHub (steps
+for this are below), you can navigate to
+https://zenodo.org/account/settings/github/repository/cthoyt/figshare-client to
+see the DOI for the release and link to the Zenodo record for it.
+
+#### Registering with the Python Package Index (PyPI)
+
+The [Python Package Index (PyPI)](https://pypi.org) hosts packages so they can
+be easily installed with `pip`, `uv`, and equivalent tools.
+
+1. Register for an account [here](https://pypi.org/account/register)
+2. Navigate to https://pypi.org/manage/account and make sure you have verified
+   your email address. A verification email might not have been sent by default,
+   so you might have to click the "options" dropdown next to your address to get
+   to the "re-send verification email" button
+3. 2-Factor authentication is required for PyPI since the end of 2023 (see this
+   [blog post from PyPI](https://blog.pypi.org/posts/2023-05-25-securing-pypi-with-2fa/)).
+   This means you have to first issue account recovery codes, then set up
+   2-factor authentication
+4. Issue an API token from https://pypi.org/manage/account/token
+
+This only needs to be done once per developer.
+
+#### Configuring your machine's connection to PyPI
+
+This needs to be done once per machine.
+
+```console
+$ uv tool install keyring
+$ keyring set https://upload.pypi.org/legacy/ __token__
+$ keyring set https://test.pypi.org/legacy/ __token__
+```
+
+Note that this deprecates previous workflows using `.pypirc`.
+
+### 📦 Making a Release
+
+#### Uploading to PyPI
+
+After installing the package in development mode and installing `tox` with
+`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, run
+the following from the console:
+
+```console
+$ tox -e finish
+```
+
+This script does the following:
+
+1. Uses [bump-my-version](https://github.com/callowayproject/bump-my-version) to
+   switch the version number in the `pyproject.toml`, `CITATION.cff`,
+   `src/figshare_client/version.py`, and
+   [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix
+2. Packages the code in both a tar archive and a wheel using
+   [`uv build`](https://docs.astral.sh/uv/guides/publish/#building-your-package)
+3. Uploads to PyPI using
+   [`uv publish`](https://docs.astral.sh/uv/guides/publish/#publishing-your-package).
+4. Push to GitHub. You'll need to make a release going with the commit where the
+   version was bumped.
+5. Bump the version to the next patch. If you made big changes and want to bump
+   the version by minor, you can use `tox -e bumpversion -- minor` after.
+
+#### Releasing on GitHub
+
+1. Navigate to https://github.com/cthoyt/figshare-client/releases/new to draft a
+   new release
+2. Click the "Choose a Tag" dropdown and select the tag corresponding to the
+   release you just made
+3. Click the "Generate Release Notes" button to get a quick outline of recent
+   changes. Modify the title and description as you see fit
+4. Click the big green "Publish Release" button
+
+This will trigger Zenodo to assign a DOI to your release as well.
+
+### Updating Package Boilerplate
+
+This project uses `cruft` to keep boilerplate (i.e., configuration, contribution
+guidelines, documentation configuration) up-to-date with the upstream
+cookiecutter package. Install cruft with either `uv tool install cruft` or
+`python3 -m pip install cruft` then run:
+
+```console
+$ cruft update
+```
+
+More info on Cruft's update command is available
+[here](https://github.com/cruft/cruft?tab=readme-ov-file#updating-a-project).
+
+</details>

figshare_client-0.0.1/pyproject.toml

@@ -0,0 +1,260 @@
+[build-system]
+requires = ["uv_build>=0.9.6,<1.0"]
+build-backend = "uv_build"
+
+[project]
+name = "figshare_client"
+version = "0.0.1"
+description = "A client to Figshare"
+readme = "README.md"
+authors = [
+    { name = "Charles Tapley Hoyt", email = "cthoyt@gmail.com" }
+]
+maintainers = [
+    { name = "Charles Tapley Hoyt", email = "cthoyt@gmail.com" }
+]
+
+# See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#classifiers
+# Search tags using the controlled vocabulary at https://pypi.org/classifiers
+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 :: 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
+    "cookiecutter",
+    "figshare",
+]
+
+# License Information.
+# See PEP-639 at https://peps.python.org/pep-0639/#add-license-files-key
+license-files = [
+    "LICENSE",
+]
+
+requires-python = ">=3.10"
+dependencies = [
+    "pydantic",
+    "requests",
+    "pystow",
+]
+
+# see https://peps.python.org/pep-0735/ and https://docs.astral.sh/uv/concepts/dependencies/#dependency-groups
+[dependency-groups]
+tests = [
+    "pytest",
+    "coverage[toml]",
+]
+docs = [
+    "sphinx>=8,<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",
+]
+
+# see https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#dependencies-optional-dependencies
+[project.optional-dependencies]
+
+
+# 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/
+[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"
+
+[tool.cruft]
+skip = [
+    "**/__init__.py",
+    "tests/*"
+]
+
+# MyPy, see https://mypy.readthedocs.io/en/stable/config_file.html
+[tool.mypy]
+plugins = [
+    "pydantic.mypy",
+]
+
+# Doc8, see https://doc8.readthedocs.io/en/stable/readme.html#ini-file-usage
+[tool.doc8]
+max-line-length = 120
+
+# Pytest, see https://docs.pytest.org/en/stable/reference/customize.html#pyproject-toml
+[tool.pytest.ini_options]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+]
+
+# Coverage, see https://coverage.readthedocs.io/en/latest/config.html
+[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]
+# See https://docs.astral.sh/ruff/rules
+extend-select = [
+    "F", # pyflakes
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
+    "C90", # mccabe
+    "I", # isort
+    "UP", # pyupgrade
+    "D", # pydocstyle
+    "DOC", # pydoclint
+    "B", # bugbear
+    "S", # bandit
+    "T20", # print
+    "N", # pep8 naming
+    "ERA", # eradicate commented out code
+    "NPY", # numpy checks
+    "RUF", # ruff rules
+    "C4", # comprehensions
+]
+ignore = [
+    "D105", # Missing docstring in magic method
+    "E203", # Black conflicts with the following
+]
+
+# See https://docs.astral.sh/ruff/settings/#per-file-ignores
+[tool.ruff.lint.per-file-ignores]
+# Ignore security issues in the version.py, which are inconsistent
+"src/figshare_client/version.py" = ["S603", "S607"]
+# Ignore commented out code in Sphinx configuration file
+"docs/source/conf.py" = ["ERA001"]
+# Prints are okay in notebooks
+"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]
+# see https://docs.astral.sh/ruff/settings/#format_docstring-code-format
+docstring-code-format = true
+
+[tool.bumpversion]
+current_version = "0.0.1"
+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.1/src/figshare_client/__init__.py

@@ -0,0 +1,9 @@
+"""A client to Figshare."""
+
+from .api import File, ensure_files, get_files
+
+__all__ = [
+    "File",
+    "ensure_files",
+    "get_files",
+]

figshare_client-0.0.1/src/figshare_client/__main__.py

@@ -0,0 +1,6 @@
+"""Entrypoint module, in case you use `python -m figshare_client`."""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

figshare_client-0.0.1/src/figshare_client/api.py

@@ -0,0 +1,53 @@
+"""Interact with the Figshare API."""
+
+from pathlib import Path
+
+import pystow
+import requests
+from pydantic import BaseModel, ByteSize, HttpUrl
+from tqdm.contrib import tmap
+from tqdm.contrib.concurrent import thread_map
+
+__all__ = [
+    "File",
+    "ensure_files",
+    "get_files",
+]
+
+BASE_URL = "https://api.figshare.com/v2/articles"
+MODULE = pystow.module("figshare")
+
+
+class File(BaseModel):
+    """An object representing a file in Figshare."""
+
+    id: int
+    name: str
+    size: ByteSize
+    is_link_only: bool
+    download_url: HttpUrl
+    supplied_md5: str | None = None
+    computed_md5: str | None = None
+    mimetype: str | None = None
+
+
+def get_files(record_id: int) -> list[File]:
+    """Get files for a record."""
+    url = f"{BASE_URL}/{record_id}/files"
+    res = requests.get(url, timeout=5)
+    res.raise_for_status()
+    return [File.model_validate(f) for f in res.json()]
+
+
+def ensure_files(record_id: int, *, concurrent: bool = True) -> dict[Path, File]:
+    """Ensure all files for a record."""
+    files = get_files(record_id)
+    submodule = MODULE.module(str(record_id))
+
+    def _func(file: File) -> tuple[Path, File]:
+        return submodule.ensure(url=str(file.download_url)), file
+
+    if concurrent:
+        return dict(thread_map(_func, files))
+    else:
+        return dict(tmap(_func, files))

figshare_client-0.0.1/src/figshare_client/cli.py

@@ -0,0 +1,16 @@
+"""Command line interface for :mod:`figshare_client`."""
+
+import click
+
+__all__ = [
+    "main",
+]
+
+
+@click.command()
+def main() -> None:
+    """CLI for figshare_client."""
+
+
+if __name__ == "__main__":
+    main()

figshare_client-0.0.1/src/figshare_client/py.typed

@@ -0,0 +1 @@
+

figshare_client-0.0.1/src/figshare_client/version.py

@@ -0,0 +1,39 @@
+"""Version information for :mod:`figshare_client`.
+
+Run with ``python -m figshare_client.version``
+"""
+
+import os
+from subprocess import CalledProcessError, check_output
+
+__all__ = [
+    "VERSION",
+    "get_git_hash",
+    "get_version",
+]
+
+VERSION = "0.0.1"
+
+
+def get_git_hash() -> str:
+    """Get the :mod:`figshare_client` git hash."""
+    with open(os.devnull, "w") as devnull:
+        try:
+            ret = check_output(
+                ["git", "rev-parse", "HEAD"],
+                cwd=os.path.dirname(__file__),
+                stderr=devnull,
+            )
+        except CalledProcessError:
+            return "UNHASHED"
+        else:
+            return ret.strip().decode("utf-8")[:8]
+
+
+def get_version(with_git_hash: bool = False) -> str:
+    """Get the :mod:`figshare_client` version string, including a git hash."""
+    return f"{VERSION}-{get_git_hash()}" if with_git_hash else VERSION
+
+
+if __name__ == "__main__":
+    print(get_version(with_git_hash=True))  # noqa:T201