hivecraft 1.0.7

Hivecraft is a tool to create, test and compile a folder with .alghive extension.

Hivecraft

Hivecraft - AlgoHive file forge

Hivecraft is a python module for creating and managing AlgoHive puzzles. It is a tool for developers to create, test, manage and compile puzzles for the AlgoHive platform. AlgoHive works by using a proprietary file format to define puzzles, and Hivecraft is a tool to help developers create these files. It comes with the required modules to implement tools around the HiveCraft logic. It also comes with a complete CLI.

AlgoHive

AlgoHive is a web, self-hostable plateform that allows developers to create puzzles for developers to solve. Each puzzle contains two parts to solve, allowing developers to test their skills in a variety of ways. The puzzles are created using a proprietary file format that is compiled into a single file for distribution.

Table of contents

• Hivecraft- AlgoHive file forge
• AlgoHive
• Table of contents
• Installation
• Run the CLI
• Run unit tests
• CLI Documentation
  • hivecraft create
  • hivecraft compile
  • hivecraft extract
  • hivecraft test
• AlgoHive file format
  • Contents of the file
    • forge.py
    • decrypt.py
    • unveil.py
    • cipher.html
    • obscure.html
    • props/meta.xml
    • props/desc.xml
• Module Documentation
  • Alghive class
  • DescProps class
  • MetaProps class
  • PUZZLES_DIFFICULTY
  • __version__
• License

Installation

To use Hivecraft, you need to have Python 3.6 or higher installed on your system. Install the package using pip:

pip install hivecraft

Run the CLI

To run the CLI, you need to have Python 3.6 or higher installed on your system. You can run the CLI using the following command:

# If installed using pip
hivecraft {command}
# Or in development mode
python3 -m hivecraft {command}

Run unit tests

To run the unit tests, you need to have Python 3.6 or higher installed on your system. You can run the unit tests using the following command:

python3 -m pytest tests/

CLI Documentation

The hivecraft command-line tool provides several commands to manage AlgoHive puzzles.

hivecraft create

Creates a new puzzle folder structure with template files.

hivecraft create <name> [--force | -f]

Arguments:

• <name>: (Required) The name of the puzzle folder to create.
• --force, -f: (Optional) Overwrite the folder if it already exists.

hivecraft compile

Compiles a puzzle folder into a .alghive file. By default, it runs tests before compiling.

hivecraft compile <folder> [--skip-test | -s] [--test-count <count>]

Arguments:

• <folder>: (Required) Path to the puzzle folder.
• --skip-test, -s: (Optional) Skip running tests before compiling.
• --test-count <count>: (Optional) Number of tests to run if testing is enabled (default: 100).

hivecraft extract

Extracts the contents of an .alghive file into a folder.

hivecraft extract <file> [--output | -o <output_folder>] [--force | -f]

Arguments:

• <file>: (Required) Path to the .alghive file.
• --output, -o <output_folder>: (Optional) Specify the output folder name. Defaults to the .alghive filename without the extension.
• --force, -f: (Optional) Overwrite the output folder if it already exists.

hivecraft test

Runs integrity checks and execution tests on a puzzle folder.

hivecraft test <folder> [--count | -c <count>]

Arguments:

• <folder>: (Required) Path to the puzzle folder.
• --count, -c <count>: (Optional) Number of test cycles to run (default: 10). Each cycle generates input, runs decrypt, and runs unveil.

AlgoHive file format

The AlgoHive file format is a concealing ZIP file that contains multiple files and directories to define a puzzle. The extension of the file is .alghive.

Contents of the file

The file contains the following directories and files:

Name	Description
forge.py	This executable python file will generate a unique input for a given seed for the puzzle.
decrypt.py	This executable python file will decrypt the input and output the solution for the first part of the puzzle
unveil.py	This executable python file will decrypt the input and output the solution for the second part of the puzzle
cipher.html	This HTML file contains the puzzle's first part text and example input/output.
obscure.html	This HTML file contains the puzzle's second part text and example input/output.
props/	This directory contains the properties of the puzzle, such as the author, creation date and difficulty.
props/meta.xml	This XML file contains the meta properties of the file
props/desc.xml	This markdown file contains the description of the puzzle.

forge.py

This file is an executable python file that will generate a unique input for a given seed for the puzzle. The file should contain a class called Forge that has a method constructor __init__ that takes a lines_count and a seed as arguments. The class should have a method called run that returns a list of strings that will be the input for the puzzle. The python file should be executable and should generate the input file input.txt for debugging purposes.

# forge.py - Generate input for the puzzle
import sys
import random

class Forge:
    def __init__(self, lines_count: int, unique_id: str = None):
        self.lines_count = lines_count
        self.unique_id = unique_id

    def run(self) -> list:
        random.seed(self.unique_id)
        lines = []
        for _ in range(self.lines_count):
            lines.append(self.generate_line(_))
        return lines

if __name__ == '__main__':
    lines_count = int(sys.argv[1])
    unique_id = sys.argv[2]
    forge = Forge(lines_count, unique_id)
    lines = forge.run()
    with open('input.txt', 'w') as f:
        f.write('\n'.join(lines))

decrypt.py

This file is an executable python file that will decrypt the input and output the solution for the first part of the puzzle. The file should contain a class called Decrypt that has a method constructor __init__ that takes a list of lines as arguments. The class should have a method called run that, given the previously setup lines, return a string or a number that is the solution for the first part of the puzzle. The python file should be executable.

class Decrypt:
    def __init__(self, lines: list):
        self.lines = lines

    def run(self):
        # TODO: TO BE IMPLEMENTED
        pass

if __name__ == '__main__':
    with open('input.txt') as f:
        lines = f.readlines()
    decrypt = Decrypt(lines)
    solution = decrypt.run()
    print(solution)

unveil.py

This file is an executable python file that will decrypt the input and output the solution for the second part of the puzzle. The file should contain a class called Unveil that has a method constructor __init__ that takes a list of lines as arguments. The class should have a method called run that, given the previously setup lines, return a string or a number that is the solution for the second part of the puzzle. The python file should be executable.

class Unveil:
    def __init__(self, lines: list):
        self.lines = lines

    def run(self):
        # TODO: TO BE IMPLEMENTED
        pass

if __name__ == '__main__':
    with open('input.txt') as f:
        lines = f.readlines()
    unveil = Unveil(lines)
    solution = unveil.run()
    print(solution)

cipher.html

This file is an HTML file that contains the puzzle's first part text and example input/output. The file must contain a <article> surrounding the content. The content can be written using <p> tags for paragraphs and <pre> or <code> tags for code blocks. This file should contain basic examples of the input and output of the puzzle.

<article>
  <h2>First part of the puzzle</h2>

  <p>I'm a paragraph</p>

  <code>
    <pre>
      I'm a code block
    </pre>
  </code>
</article>

obscure.html

This file is an HTML file that contains the puzzle's second part text and example input/output. The file must contain a <article> surrounding the content. The content can be written using <p> tags for paragraphs and <pre> or <code> tags for code blocks. This file should contain basic examples of the input and output of the puzzle.

<article>
  <h2>Second part of the puzzle</h2>

  <p>I'm a paragraph</p>

  <code>
    <pre>
      I'm a code block
    </pre>
  </code>
</article>

props/meta.xml

This file is an XML file that contains the meta properties of the file. The file should contain the following properties:

<Properties xmlns="http://www.w3.org/2001/WMLSchema">
    <author>$AUTHOR</author>
    <created>$CREATED</created>
    <modified>$MODIFIED</modified>
    <hivecraft_version>$HIVECRAFT_VERSION</hivecraft_version>
    <title>Meta</title>
    <id>$UNIQUE_ID</id>
</Properties>

This file will allow to be able to define the author, the creation date and the modification date of the puzzle.

props/desc.xml

This file is an XML file that contains the description of the puzzle. The file should contain the following properties:

<Properties xmlns="http://www.w3.org/2001/WMLSchema">
    <difficulty>$DIFFICULTY</difficulty>
    <language>$LANGUAGE</language>
    <title>$TITLE</title>
    <index>$INDEX</index>
</Properties>

Module Documentation

The hivecraft Python package provides classes and constants for programmatic interaction with AlgoHive puzzles.

Alghive class

The main class for managing an AlgoHive puzzle folder.

• Initialization: Alghive(folder_name)
• Methods:
  • check_integrity(): Validates the folder structure, required files, script classes, and property files. Raises ValueError on failure.
  • run_tests(count): Executes the forge, decrypt, and unveil scripts count times with random seeds to check for runtime errors. Raises RuntimeError on failure.
  • zip_folder(): Compiles the validated puzzle folder into an .alghive file in the current working directory.

DescProps class

Handles reading, validating, and writing the props/desc.xml file. Attributes (difficulty, language, title, index) are dynamically assigned and can be accessed/modified directly.

MetaProps class

Handles reading, validating, and writing the props/meta.xml file. Attributes (author, created, modified, hivecraft_version, title, id) are dynamically assigned and can be accessed/modified directly. The modified timestamp is automatically updated when writing.

PUZZLES_DIFFICULTY

A list of strings representing the valid difficulty levels: ['EASY', 'MEDIUM', 'HARD', 'EXPERT'].

__version__

A string containing the installed version of the hivecraft package.

License

This project is licensed under the MIT License - see the LICENSE file for details.