Skip to main content

Build status Lint status Documentation Coverage Code style Version License

Collection of tasks for I/O. Designed to be used both in Prefect workflows and as modular, useful pieces of code.

Installation

The collection can be installed using:

pip install io-collection

Note that loading and saving images requires additional dependencies. Install these using:

pip install 'io-collection[images]'

We recommend using Poetry to manage and install dependencies. To install into your Poetry project, use:

poetry add io-collection

To include additional dependencies for loading and saving images:

poetry add 'io-collection[images]'

Usage

Prefect workflows

All tasks in this collection are wrapped in a Prefect @task decorator, and can be used directly in a Prefect @flow. Running tasks within a Prefect flow enables you to take advantage of features such as automatically retrying failed tasks, monitoring workflow states, running tasks concurrently, deploying and scheduling flows, and more.

from prefect import flow
from io_collection.<module_name> import <task_name>

@flow
def run_flow():
    <task_name>()

if __name__ == "__main__":
    run_flow()

See cell-abm-pipeline for examples of using tasks from different collections to build a pipeline for simulating and analyzing agent-based model data.

Individual tasks

Not all use cases require a full workflow. Tasks in this collection can be used without the Prefect @task decorator by simply importing directly from the module:

from io_collection.<module_name>.<task_name> import <task_name>

def main():
    <task_name>()

if __name__ == "__main__":
    main()

or using the .fn() method:

from io_collection.<module_name> import <task_name>

def main():
    <task_name>.fn()

if __name__ == "__main__":
    main()

Metadata

Release files for io-collection 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for io-collection 1.1.0
File Size Uploaded
io_collection-1.1.0.tar.gz 12.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for io-collection 1.1.0
File Interpreter ABI Platform
io_collection-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 36.8 kB

Release files / io_collection-1.1.0.tar.gz

Download URL io_collection-1.1.0.tar.gz
Size 12.8 kB
Tags Source
SHA-256 checksum
How to use checksums
974b8d2a92f04e8c304215449cf6aafe1ce079738ddc91c37be8d11744c17a20
BLAKE2b-256 checksum
How to use checksums
36ce931c85a5a0efd15b30d6313eeba45b03685ca8e97c2e5f602ba4183a8bb6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.6

Release files / io_collection-1.1.0-py3-none-any.whl

Download URL io_collection-1.1.0-py3-none-any.whl
Size 24.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ae50d11a2ebffc0abc66291955c3f6019416a9e327a6d426f91cfad75764e6f7
BLAKE2b-256 checksum
How to use checksums
37726b9d1d4237c2b530a862c5b69d70e7028f7ae9d268ba6ebb112571c16b89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.6

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page