Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.98 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.98 KB

About puzzle_generator

PyPI version Quality Gate Status codecov CodeFactor Codacy Badge Open in Gitpod

Basic functionality of puzzle_generator is to generate a single python file representing a puzzle or quiz. The upcoming questions are stored in an encrypted form, so it is difficult to read them before providing correct answers. The generated file does not have any external dependencies.

Getting started

This package is available at PyPI. It can be installed using the command

pip install puzzle-generator

examples show some basic usage.

Information for developers

The project is setup using poetry. In order to create a develompent enviroment, after cloning this repository, run the command:

poetry install --with dev

If you just want to see the examples in action, it is enough to clone this repository and run the command:

poetry install

Afterwards you can execute the commands like:

poetry run python3 examples/basic_usage.py