mnemo-assistant

PyPi | docs

A Python3.8+ web framework providing tools for journaling and note taking.

Features (in short)

• Bottle-based web framework.
• Login system (currently supports one user at a time).

Requirements

mnemo-assistant has been tested with Python 3.8 and 3.9. We recommend installing it using pipx (see below) to avoid dependency conflicts with other packages. The packages it depends on are listed in our dependency graph. We use poetry to handle our dependencies.

Install

We recommend installing mnemo-assistant using pipx. Check how to install pipx here if you don't have it yet! Once you have pipx ready on your system, install the latest stable release of mnemo-assistant by running: pipx install mnemo-assistant. If you see the stars (✨ 🌟 ✨), then the installation went well!

Usage

Run mnemo to access the barber's services. Add -h to see the full help page of a command! Also, run mnemo-autocomplete -s BASH_TYPE to activate autocompletion. BASH_TYPE currently supports: bash, fish, and zsh.

Contributing

We welcome any contributions to mnemo-assistant. In short, we use black to standardize code format. Any code change also needs to pass mypy checks. For more details, please refer to our contribution guidelines if this is your first time contributing! Also, check out our code of conduct.

License

MIT License - Copyright (c) 2021 Gabriele Girelli