Metadata-Version: 2.1
Name: datacite-websnap
Version: 3.0.0
Summary: CLI tool that exports DataCite records to an S3 bucket.
Keywords: S3,Boto3,boto3,API,backup,AWS,AWS SDK,AWS SDK for Python,DataCite
Author: Rebecca Buchholz
Maintainer-Email: EnviDat <envidat@wsl.ch>
License: MIT
Classifier: Programming Language :: Python :: 3
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: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet
Classifier: Topic :: System
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Archiving :: Backup
Classifier: Topic :: System :: Archiving :: Mirroring
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Project-URL: documentation, https://git.wsl.ch/EnviDat/datacite-websnap/-/blob/main/README.md
Project-URL: repository, https://git.wsl.ch/EnviDat/datacite-websnap
Project-URL: changelog, https://git.wsl.ch/EnviDat/datacite-websnap/-/blob/main/CHANGELOG.md
Requires-Python: >=3.11
Requires-Dist: click>=8.3.3
Requires-Dist: requests>=2.33.1
Requires-Dist: pydantic>=2.13.0
Requires-Dist: boto3>=1.43.4
Requires-Dist: click-extra>=7.14.1
Requires-Dist: eth-datacite-validator>=0.1.4
Description-Content-Type: text/markdown

# datacite-websnap

<div>
    <img alt="Supported Python Versions" src="https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13|%203.14-blue">
     <a href="https://pypi.org/project/datacite-websnap" target="_blank">
        <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/datacite-websnap">
    </a>
    <a href="https://git.wsl.ch/EnviDat/datacite-websnap/-/blob/main/LICENSE" target="_blank">
      <img alt="License" src="https://img.shields.io/pypi/l/datacite-websnap?color=%232780C1">
    </a>
    <img alt="Code Style - ruff" src="https://img.shields.io/badge/style-ruff-41B5BE?style=flat">
</div>

### CLI tool that exports DataCite records to an S3 bucket. 
#### Also supports exporting records to a local machine.

---


## Purpose

<ul>
  <li>Developed to facilitate interoperability between the data platforms of the ETH research institutions in Switzerland.</li>
  <li>Empowers research institutions to share their DataCite metadata records by exporting the records to publicly accessible S3 cloud storage.</li>
  <li>Tool also supports exporting a single DataCite DOI XML record, JSON record, and associated resource data files.</li>
</ul>


## Installation

```bash
pip install datacite-websnap
```


## Terminal Documentation

### General
```bash
datacite-websnap --help
```

### Commands 
```bash
datacite-websnap bulk-export --help
```

```bash
datacite-websnap doi-export --help
```


## Documentation

See the [full documentation](https://git-pages.wsl.ch/datacite-websnap-5b86d6) for commands, usage examples, and reference.

- [Commands](https://git-pages.wsl.ch/datacite-websnap-5b86d6/commands/bulk-export/): `bulk-export`, `doi-export`, common options
- [Usage](https://git-pages.wsl.ch/datacite-websnap-5b86d6/usage/s3/): S3 bucket and local machine examples
- [Reference](https://git-pages.wsl.ch/datacite-websnap-5b86d6/reference/credentials/): credentials, filters, logs, DataCite API


## Author

<a href="http://www.linkedin.com/in/rebeccabuchholz" target="_blank">Rebecca Buchholz</a>

<a href="https://www.envidat.ch" target="_blank">EnviDat</a> is the environmental data 
portal of the Swiss Federal Institute for Forest, Snow and Landscape Research WSL. 


## Inspiration

<h3><a href="https://pypi.org/project/websnap" target="_blank">websnap</a></h3>

An EnviDat PyPI package that copies files retrieved from an API to an S3 bucket or a local machine.

## License

<a href="https://git.wsl.ch/EnviDat/datacite-websnap/-/blob/main/LICENSE" target="_blank">MIT License</a>