readme.py

import snakemd

from pymon import brain


doc = snakemd.new_doc("README")

doc.add_header("Pymon")

doc.add_paragraph(
    """
    Pymon was developed to help students find answers to course questions.
    It is not currently hosted for public use, but you can self-host it using the
    code found in this repo. Currently, I am running the bot on a home desktop.
    """
)

doc.add_header("How to Run the Bot", 2)

doc.add_paragraph(
    """
    If you'd like to use this bot in your own server, start by cloning/forking this repo.
    After that, you'll want to create a .env file in the root directory of the repo
    with the following contents:
    """
)

doc.add_code(
    "DISCORD_TOKEN=[insert token here]",
    "env"
)

doc.add_paragraph(
    """
    If you'd like to include your own knowledge base, you can do so by also creating
    a KNOWLEDGE_PATH environment variable in your .env file. This should point to a 
    local file or a remote URL. Otherwise, the bot will use the queries.json file,
    which is designed specifically for a course I am teaching.
    """
)

doc.add_code(
    "KNOWLEDGE_PATH=[insert path here]",
    "env"
)

doc.add_paragraph(
    """
    After that, you'll want to install all requirements. Luckily, I've included a
    requirements.txt file. You can use the following code to install all
    requirements:
    """
)

doc.add_code(
    "pip install -r requirements.txt",
    "shell"
)

doc.add_paragraph(
    """
    From there, you can run the bot like any other Python script:
    """
)

doc.add_code(
    "python3 pymon.py",
    "shell"
)

doc.add_header("How to Use the Bot", 2)

doc.add_paragraph(
    """
    Pymon currently has two main services. First, you
    can directly @ the bot to get it to respond with the top three
    matching questions to your query. The response will include an ID
    which you can lookup with the `/get` command. Alternatively,
    you can use the list in the next section directly. Note that the
    questions don't have any organization, so asking the bot to give
    you some matches is sometimes a better start. 
    """
)

doc.add_header("Question IDs", 2)

doc.add_paragraph(
    """
    Currently, the bot can answer the following questions. 
    The numbers map directly to the lookup IDs, so if you want
    an answer to any of these questions, just ask the bot with
    `/get`. 
    """
)

questions = []
pymon_brain = brain.Brain()
queries = pymon_brain.get_all_queries()
for query in queries:
    item = f"\"{query.query}\" by {', '.join(query.authors)}"
    questions.append(item)

doc.add_ordered_list(questions)

doc.add_horizontal_rule()

doc.add_paragraph(
    """
    This README was automatically generated using SnakeMD. 
    """
)

doc.output_page()