Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.25 KB

README.md

File metadata and controls

41 lines (23 loc) · 1.25 KB

Python Bitmap Generator

This program was created with the intent of learning how to generate bitmaps from scratch. Please feel free to open a pull-request, issue, or fork!

This tool was built using Python version 3.11.2. I have not tested this using any other versions, although it likely works with substantially older versions of Python3.

INSTALLATION

Note: This program has onlu officially been tested on Ubuntu and Windows 10. In theory it should work on any platform that supports Python3.8

run pip install python-bmp-generator

USAGE

CLI

run python-bmp-generator -h for help.

example: python-bmp-generator -r 0 -g 255 -b 0 -o green-image.bmp

Python Module

There is really only one function at this time. See "create_bmp.py" for details.

include like: from python_bmp_generator import create_bmp

example:

from python_bmp_generator import create_bmp

create_bmp(file_name="output.bmp", width=100, height=100, red=255, green=0, blue=255)

CONTRIBUTING

Testing

Note: these tests run via hypothesis which performs an exhaustive series of image generations by sampling the range of supported inputes (width, height, etc.)

run python -m unittest to run the test suite.