# IMAGEIO
[](https://github.com/imageio/imageio/actions/workflows/ci.yml)
[](https://github.com/imageio/imageio/actions/workflows/cd.yml)
[](https://codecov.io/gh/imageio/imageio)
[](https://imageio.readthedocs.io)
[](https://pypi.python.org/pypi/imageio/)
[](https://pypi.python.org/pypi/imageio/)
[](https://doi.org/10.5281/zenodo.1488561)
Website: <https://imageio.readthedocs.io/>
Imageio is a mature Python library that makes it easy to read and write image
and video data. This includes animated images, video, volumetric data, and
scientific formats. It is cross-platform, runs on Python 3.9+, and is easy to
install.
Professional support is available via
[Tidelift](https://tidelift.com/funding/github/pypi/imageio).
## Example
Here's a minimal example of how to use imageio. See the docs for [more
examples](https://imageio.readthedocs.io/en/stable/examples.html).
```python
import imageio.v3 as iio
im = iio.imread('imageio:chelsea.png') # read a standard image
im.shape # im is a NumPy array of shape (300, 451, 3)
iio.imwrite('chelsea.jpg', im) # convert to jpg
```
## API in a nutshell
You just have to remember a handful of functions:
```python
imread() # for reading
imwrite() # for writing
imiter() # for iterating image series (animations/videos/OME-TIFF/...)
improps() # for standardized metadata
immeta() # for format-specific metadata
imopen() # for advanced usage
```
See the [API docs](https://imageio.readthedocs.io/en/stable/reference/index.html) for more information.
## Features
- Simple interface via a concise set of functions
- Easy to
[install](https://imageio.readthedocs.io/en/stable/getting_started/installation.html)
using Conda or pip
- Few core dependencies (only NumPy and Pillow)
- Pure Python, runs on Python 3.9+, and PyPy
- Cross platform, runs on Windows, Linux, macOS
- More than 295 supported
[formats](https://imageio.readthedocs.io/en/stable/formats/index.html)
- Read/Write support for various
[resources](https://imageio.readthedocs.io/en/stable/getting_started/requests.html)
(files, URLs, bytes, FileLike objects, ...)
- High code quality and large test suite including functional, regression, and
integration tests
## Dependencies
Minimal requirements:
- Python 3.9+
- NumPy
- Pillow >= 8.3.2
Optional Python packages:
- imageio-ffmpeg (for working with video files)
- pyav (for working with video files)
- tifffile (for working with TIFF files)
- itk or SimpleITK (for ITK plugin)
- astropy (for FITS plugin)
- [imageio-flif](https://codeberg.org/monilophyta/imageio-flif) (for working
with [FLIF](https://github.com/FLIF-hub/FLIF) image files)
## Security contact information
To report a security vulnerability, please use the [Tidelift security
contact](https://tidelift.com/security). Tidelift will coordinate the fix and
disclosure.
## ImageIO for enterprise
Available as part of the Tidelift Subscription.
The maintainers of imageio and thousands of other packages are working with
Tidelift to deliver commercial support and maintenance for the open source
dependencies you use to build your applications. Save time, reduce risk, and
improve code health, while paying the maintainers of the exact dependencies you
use. ([Learn
more](https://tidelift.com/subscription/pkg/pypi-imageio?utm_source=pypi-imageio&utm_medium=referral&utm_campaign=readme))
## Details
The core of ImageIO is a set of user-facing APIs combined with a plugin manager.
API calls choose sensible defaults and then call the plugin manager, which
deduces the correct plugin/backend to use for the given resource and file
format. The plugin manager adds sensible backend-specific defaults and then
calls one of ImageIOs many backends to perform the actual loading. This allows
ImageIO to take care of most of the gory details of loading images for you,
while still allowing you to customize the behavior when and where you need to.
You can find a more detailed explanation of this process in [our
documentation](https://imageio.readthedocs.io/en/stable/user_guide/overview.html).
## Contributing
We welcome contributions of any kind. Here are some suggestions on how you are
able to contribute
- add missing formats to the format list
- suggest/implement support for new backends
- report/fix any bugs you encounter while using ImageIO
To assist you in getting started with contributing code, take a look at the
[development
section](https://imageio.readthedocs.io/en/stable/development/index.html) of the
docs. You will find instructions on setting up the dev environment as well as
examples on how to contribute code.
Raw data
{
"_id": null,
"home_page": null,
"name": "ImageIO",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Sebastian Wallkotter <sebastian@wallkoetter.net>, Almar Klein <almar.klein@gmail.com>",
"keywords": "image, video, imread, imwrite, io, animation, ffmpeg, image processing, numpy, format conversion, scientific imaging, medical imaging, volumetric, video encoding, multimedia, gif, tiff, png, jpeg",
"author": "ImageIO contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a3/6f/606be632e37bf8d05b253e8626c2291d74c691ddc7bcdf7d6aaf33b32f6a/imageio-2.37.2.tar.gz",
"platform": null,
"description": "# IMAGEIO\n\n[](https://github.com/imageio/imageio/actions/workflows/ci.yml)\n[](https://github.com/imageio/imageio/actions/workflows/cd.yml)\n[](https://codecov.io/gh/imageio/imageio)\n[](https://imageio.readthedocs.io)\n\n[](https://pypi.python.org/pypi/imageio/)\n[](https://pypi.python.org/pypi/imageio/)\n\n[](https://doi.org/10.5281/zenodo.1488561)\n\nWebsite: <https://imageio.readthedocs.io/>\n\nImageio is a mature Python library that makes it easy to read and write image\nand video data. This includes animated images, video, volumetric data, and\nscientific formats. It is cross-platform, runs on Python 3.9+, and is easy to\ninstall.\n\nProfessional support is available via\n[Tidelift](https://tidelift.com/funding/github/pypi/imageio).\n\n## Example\n\nHere's a minimal example of how to use imageio. See the docs for [more\nexamples](https://imageio.readthedocs.io/en/stable/examples.html).\n\n```python\nimport imageio.v3 as iio\nim = iio.imread('imageio:chelsea.png') # read a standard image\nim.shape # im is a NumPy array of shape (300, 451, 3)\niio.imwrite('chelsea.jpg', im) # convert to jpg\n```\n\n## API in a nutshell\n\nYou just have to remember a handful of functions:\n\n```python\nimread() # for reading\nimwrite() # for writing\nimiter() # for iterating image series (animations/videos/OME-TIFF/...)\nimprops() # for standardized metadata\nimmeta() # for format-specific metadata\nimopen() # for advanced usage\n```\n\nSee the [API docs](https://imageio.readthedocs.io/en/stable/reference/index.html) for more information.\n\n## Features\n\n- Simple interface via a concise set of functions\n- Easy to\n [install](https://imageio.readthedocs.io/en/stable/getting_started/installation.html)\n using Conda or pip\n- Few core dependencies (only NumPy and Pillow)\n- Pure Python, runs on Python 3.9+, and PyPy\n- Cross platform, runs on Windows, Linux, macOS\n- More than 295 supported\n [formats](https://imageio.readthedocs.io/en/stable/formats/index.html)\n- Read/Write support for various\n [resources](https://imageio.readthedocs.io/en/stable/getting_started/requests.html)\n (files, URLs, bytes, FileLike objects, ...)\n- High code quality and large test suite including functional, regression, and\n integration tests\n\n## Dependencies\n\nMinimal requirements:\n\n- Python 3.9+\n- NumPy\n- Pillow >= 8.3.2\n\nOptional Python packages:\n\n- imageio-ffmpeg (for working with video files)\n- pyav (for working with video files)\n- tifffile (for working with TIFF files)\n- itk or SimpleITK (for ITK plugin)\n- astropy (for FITS plugin)\n- [imageio-flif](https://codeberg.org/monilophyta/imageio-flif) (for working\n with [FLIF](https://github.com/FLIF-hub/FLIF) image files)\n\n## Security contact information\n\nTo report a security vulnerability, please use the [Tidelift security\ncontact](https://tidelift.com/security). Tidelift will coordinate the fix and\ndisclosure.\n\n## ImageIO for enterprise\n\nAvailable as part of the Tidelift Subscription.\n\nThe maintainers of imageio and thousands of other packages are working with\nTidelift to deliver commercial support and maintenance for the open source\ndependencies you use to build your applications. Save time, reduce risk, and\nimprove code health, while paying the maintainers of the exact dependencies you\nuse. ([Learn\nmore](https://tidelift.com/subscription/pkg/pypi-imageio?utm_source=pypi-imageio&utm_medium=referral&utm_campaign=readme))\n\n## Details\n\nThe core of ImageIO is a set of user-facing APIs combined with a plugin manager.\nAPI calls choose sensible defaults and then call the plugin manager, which\ndeduces the correct plugin/backend to use for the given resource and file\nformat. The plugin manager adds sensible backend-specific defaults and then\ncalls one of ImageIOs many backends to perform the actual loading. This allows\nImageIO to take care of most of the gory details of loading images for you,\nwhile still allowing you to customize the behavior when and where you need to.\nYou can find a more detailed explanation of this process in [our\ndocumentation](https://imageio.readthedocs.io/en/stable/user_guide/overview.html).\n\n## Contributing\n\nWe welcome contributions of any kind. Here are some suggestions on how you are\nable to contribute\n\n- add missing formats to the format list\n- suggest/implement support for new backends\n- report/fix any bugs you encounter while using ImageIO\n\nTo assist you in getting started with contributing code, take a look at the\n[development\nsection](https://imageio.readthedocs.io/en/stable/development/index.html) of the\ndocs. You will find instructions on setting up the dev environment as well as\nexamples on how to contribute code.\n",
"bugtrack_url": null,
"license": null,
"summary": "Read and write images and video across all major formats. Supports scientific and volumetric data.",
"version": "2.37.2",
"project_urls": {
"documentation": "https://imageio.readthedocs.io",
"download": "http://pypi.python.org/pypi/imageio",
"homepage": "https://github.com/imageio/imageio",
"source": "https://github.com/imageio/imageio"
},
"split_keywords": [
"image",
" video",
" imread",
" imwrite",
" io",
" animation",
" ffmpeg",
" image processing",
" numpy",
" format conversion",
" scientific imaging",
" medical imaging",
" volumetric",
" video encoding",
" multimedia",
" gif",
" tiff",
" png",
" jpeg"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fbfe301e0936b79bcab4cacc7548bf2853fc28dced0a578bab1f7ef53c9aa75b",
"md5": "491c970f4ab56f0e7f69df4cb1516a0a",
"sha256": "ad9adfb20335d718c03de457358ed69f141021a333c40a53e57273d8a5bd0b9b"
},
"downloads": -1,
"filename": "imageio-2.37.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "491c970f4ab56f0e7f69df4cb1516a0a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 317646,
"upload_time": "2025-11-04T14:29:37",
"upload_time_iso_8601": "2025-11-04T14:29:37.948359Z",
"url": "https://files.pythonhosted.org/packages/fb/fe/301e0936b79bcab4cacc7548bf2853fc28dced0a578bab1f7ef53c9aa75b/imageio-2.37.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a36f606be632e37bf8d05b253e8626c2291d74c691ddc7bcdf7d6aaf33b32f6a",
"md5": "64b0cc407f918cb632e5e8d5af41521e",
"sha256": "0212ef2727ac9caa5ca4b2c75ae89454312f440a756fcfc8ef1993e718f50f8a"
},
"downloads": -1,
"filename": "imageio-2.37.2.tar.gz",
"has_sig": false,
"md5_digest": "64b0cc407f918cb632e5e8d5af41521e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 389600,
"upload_time": "2025-11-04T14:29:39",
"upload_time_iso_8601": "2025-11-04T14:29:39.898455Z",
"url": "https://files.pythonhosted.org/packages/a3/6f/606be632e37bf8d05b253e8626c2291d74c691ddc7bcdf7d6aaf33b32f6a/imageio-2.37.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-04 14:29:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "imageio",
"github_project": "imageio",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "imageio"
}
JSON
