Skip to main content

Mock Document Image Generator

Project description

Document Image Mocker

Warning: This project is completely experimental – do not use in real-world projects.

This tool is intended to generate images of fake documents using content seeders. It can be extended with plugins to add extra processing or content to the resulting images.

Usage

Running doc-mocker -h will display the following help

usage:  [-h] [-n NUMBER_OF_PAGES] [-t {A4}] [-s {BASIC}] [-o OUTPUT_PATH]
        {generate}

positional arguments:
  {generate}            command to run

optional arguments:
  -h, --help            show this help message and exit
  -n NUMBER_OF_PAGES, --number-of-pages NUMBER_OF_PAGES
                        number of pages to generate (default: 1)
  -t {A4}, --page-type {A4}
                        page type (default: A4)
  -s {BASIC}, --page-seeder {BASIC}
                        page seeder (default: BASIC)
  -o OUTPUT_PATH, --output-path OUTPUT_PATH
                        output path (default: current path)

Contributing

Every contribution is welcome.

Be sure to your code is PEP-8 compliant. Use black to fix your formatting before committing changes.

black main doc_mocker

Optional: Install flake8 pre-commit hook to check your code before committing.

flake8 --install-hook git
git config --bool flake8.strict true

Create a plugin

Plugins are auto-discovered if created as modules in the sub-package doc_mocker.plugins using the namespace packages convention.

Check the noise plugin to get an idea on the required structure.

Run tests

python -m pytest

Credits

View the full list of contributors. MIT licensed.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for doc-mocker, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size doc_mocker-0.0.1-py3-none-any.whl (3.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size doc-mocker-0.0.1.tar.gz (9.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page