Skip to content

kenlhlui/pyarchiveit

Repository files navigation

Caution

🚨THIS LIBRARY IS UNDER ACTIVE DEVELOPMENT. USE AT YOUR OWN RISK.🚨

📦 Pyarchiveit

Pyarchiveit is a Python library designed to interact with the Internet Archive's Archive-it API. It provides a simple interface to manage the seeds and collections within Archive-it accounts.

✨ Features

  • Create and update seeds with metadata validation
  • Retrieve seed lists with their metadata for single or multiple collections
  • Export seed data to CSV and XLSX formats

📥 Installation

You can install the library using pip:

pip install pyarchiveit

Or use uv if you have it installed:

uv add pyarchiveit

Tip

As a best practice (and since the project is under active development), you should pin the version of pyarchiveit when installing it, e.g. pip install pyarchiveit==0.1.0 or uv add pyarchiveit==0.1.0, to avoid unexpected issues from future updates.

💡 Quick Start

See the Getting Started guide for detailed installation and initialization instructions.

📚 Documentation

Visit the documentation site for complete guides and API reference.

⚫ Support

For questions or support, please open an issue on the GitHub repository.

🏗️ Development

See the contributing guide for details on how to contribute to this project.

🖊️ Author

Ken Lui - Data Curation Specialist at Map & Data Library, University of Toronto

⚖️ License

This project is licensed under the GNU GPLv3 - see the LICENSE file for details.