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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for doc_mocker-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f930c909bf43838fae98573c561d6dc3a4b6a3e7a726e3a355938d45389cf09 |
|
MD5 | 0a9e5a3554a69ea13f78431921c41273 |
|
BLAKE2b-256 | 398743a8229fd4ae3144958e8ceef8fd13e6c6f8d9c7010bb3c0f50270680422 |