Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 2.45 KB

README.md

File metadata and controls

85 lines (57 loc) · 2.45 KB
Raw

Logo

Mimage

A library for reading images in pure* Mojo 🔥

*Not pure Mojo yet, but hopefully soon.

About The Project

Mimage is a image manipulation library loosely based on Python's Pillow. The goal is to be able to read and write the most popular image formats directly from Mojo.

Quick Start

Basic usage:

import mimage as mi

def main():

  tensor = mi.imread("my/png/image.png")

Try out the tests yourself:

mojo -I .  tests/test_open_png.mojo

Roadmap

v0.1.0 ✅

  • Read simple 8-bit PNGs

Near term

  • Read jpegs

Medium term

  • Read more complex PNGs
  • Write PNGs
  • Write jpegs

Long term

  • v1.0.0 will be achieved when Mimage can open all the same images as Pillow.

Contributing

Before creating a new issue, please:

  • Check if the issue already exists. If an issue is already reported, you can contribute by commenting on the existing issue.
  • If not, create a new issue and include all the necessary details to understand/recreate the problem or feature request.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch
  3. Commit your Changes
  4. Push to the Branch
  5. Open a Pull Request

Once your changes are pushed, navigate to your fork on GitHub. And create a pull request against the original fnands/mimage repository.

  • Before creating a PR make sure it doesn't break any of the unit-tests. (e.g. mojo -I . tests/test_open_png.mojo)
  • Introducing new big features requires a new test!
  • In the pull request, provide a detailed description of the changes and why they're needed. Link any relevant issues.
  • If there are any specific instructions for testing or validating your changes, include those as well.

License

Distributed under the Apache 2.0 License with LLVM Exceptions. See LICENSE and the LLVM License for more information.

Acknowledgements