wizard-assistant-bot

Remembrall is an assistant bot for wizards of the academy.

Installing

You can install the Remembrall from PyPI:

python -m pip install wizards-remembrall

Once installed the Remembrall is avaialbe as a command line application, named remembrall.

remembrall [command] [args1, args2, ...]

List the avaialble commands:

remembrall help

Development

Set up a virtual environment (venv) by running the following command in your project directory:

python -m venv .venv

Activate the virtual environment. On Windows, run:

.\.venv\Scripts\activate.ps1

On macOS and Linux, run:

source .venv/bin/activate

Install the required dependencies by running:

pip install -r requirements.txt

Start developing your wizard assistant bot!

Remember to update a requirements.txt file in the project directory if you add new dependencies by running the

pip freeze > requirements.txt

For local development, you can install your package in editable mode:

pip install -e .

And it become available as remembrall programm.

Or can be launched as

python src/remembrall/__main__.py

Unit Tests

VS Code is configured to use unittest and knows where the tests are (see .vscode/settings.json). You can run your tests by opening the Test Explorer (the beaker icon in the Activity Bar on the side), and then clicking on the Run All Tests button (the play button at the top of the Test Explorer).

Alternatively, you can press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows) and start typing Test: Run All Tests.

The results of the tests will appear in the Test Explorer. You can click on a test to see its output in the Output pane.

To add a new tests simply add new file starting with test_*.py to tests/ folder as per configured discovery mechanism. See unittest Python Unit testing framework documentation.