Mnemosyne is:
Important features include:
You can find a more detailed explanation of the features on the webpage, as well as the general documentation.
If you just want to download the latest Mnemosyne release as a regular user, please see the Download section. If you are interested in running and changing the latest code, please read on.
We use the git version control system and Github to coordinate the development. Please use a search engine to find out how to install git on your operating system. If you are new to git and github, there are many tutorials available on the web. For example, this interactive tutorial. See also section working locally with the code and sharing your changes for some info about git and Github.
To get an overview of how all the different bits of the library fit together, see the documentation in the code at mnemosyne/libmnemosyne/docs/build/html/index.html
.
In order to keep the code looking uniform, please following the standard Python style guides PEP8 and PEP257.
You can find instructions for Windows here. The following instructions are valid for Linux and Mac (if you use homebrew or some other package manager).
To start working on Mnemosyne, you need at least the following software.
latex
and dvipng
commands must be available (e.g., TeXLive
on Linux, MacTeX
on Mac, and MikTeX
on Windows). On Arch based distributions, you'll need texlive-core
package too.These can be installed/upgraded using pip:
pip install --upgrade PyQt6 PyQt6-WebEngine matplotlib cheroot webob pillow googletrans gTTS argon2-cffi
You can either run a development version of Mnemosyne by using your system-wide Python installation, or by using a virtual environment with virtualenv. If your distribution provides and packages all necessary libraries in a recent enough version, using the system-wide Python install is probably easier and the recommended way.
First, install all dependencies with your distribution's package manager.
Then, run make
, followed by make run
from the top-level mnemosyne directory.
This will generate all the needed auxiliary files and start Mnemosyne with a separate datadir under dot_mnemosyne2
.
If you want to use mnemosyne interactively from within a python shell, run python from the top-level mnemosyne directory.
You can check if the correct local version was imported by running import mnemosyne; print(mnemosyne.__file__)
.
If your distribution does not provide all required libraries, or if the libraries are too old, create a virtual environment in the top-level directory (virtualenv venv
), activate it (source venv/bin/activate
) and install all the required dependencies with pip install
.
Then, follow the steps of the previous paragraph.
As of Mnemosyne-2.11, you may use Pyenv and Poetry to develop for this project. Pyenv allows you to easily install and switch between multiple python interpreters, while Poetry is a modern tool for dependency management.
To get started, open a terminal at the project root, and run pyenv local
. This will tell pyenv
to use the python version specified in the .python-version
file.
Before activating poetry
, make sure to run the following settings:
poetry config virtualenvs.prefer-active-python true
This will make sure that poetry
will recognize the python interpreter activated by pyenv
.
Afterwards, run poetry shell
to activate the project virtual environment. Then run poetry install
to install all dependencies on your virtual environment. You can now get started on coding for Mnemosyne.
If there is a need to change dependencies, you may either poetry add <package_name>
to add a dependency and poetry remove <package_name>
to remove one. Run the following command to update the requirements.txt
for those prefer to download project dependencies via pip install -r requirements.txt
.:
poetry export -f requirements.txt --output requirements.txt --without-hashes
As of Mnemosyne-2.11, nose
has been replaced by the modern pytest
framework.
You can run the test suite through:
make test
or:
make test-prep
python3 -m pytest tests -ra --junitxml=test-results.xml
Both commands will display a summary of test results and a junitxml file named test-results.xml
, which is useful if you wish to go through the results outside of the terminal, such as an xml reader.
If you want to get a more actionable version of test-results.xml
, you may run ./tools/convert_junitxml.py
after, which converts the test result xml into a simpler todo.txt format. Because of the way the xml is parsed, the summary count of convert_junitxml.py
and the terminal results of pytest may not always match, but the tool is sufficient for acting on the test results in a plain text editor.
Single tests can be run like this:
python3 -m pytest tests/<file_name>.py::<class_name>::<method_name>
For testing the development version it is not necessary to do a system-wide installation. If you want to do so anyway, here are the instructions.
Follow the installation instructions from above (install the dependencies, get the source code - either by cloning it from github, or by downloading and extracting the .tar.gz
archive).
Then, run the following command from within the top-level directory of the repository (which is also the location of this README.md
file):
sudo python setup.py install
Depending on your setup, you might need to replace python
with python3
. To test the installation, change to any other directory and run mnemosyne
.
For example:
cd ~
mnemosyne
If you run into the issue of non-latin characters not displaying on statistic plots, install ttf-mscorefonts-installer and regenerate the font cache of matplotlib.
brew update
brew install python@3.9 qt@5 mplayer openjpeg libffi
brew install --cask xquartz # needed for mplayer dylibs
python3 --version
brew list --versions qt@5
brew uninstall <package-name>
brew edit <package-name>
# Example: replace the file with the contents of https://raw.githubusercontent.com/Homebrew/homebrew-core/e76ed3606c8008d2b8d9636a7e4e6f62cfeb6120/Formula/python3.rb and save it
brew install <package-name>
brew pin <package-name>
pip3 install virtualenv
virtualenv --python=python3 venv
source venv/bin/activate
From now on, your shell should have a (venv)
at the beginning indicating you're inside the virtual environment. Ensure the copy of pip in the virtual environment is at least version 21.1.1 or later:
pip --version
If not, upgrade pip with
pip install --upgrade pip
pip install argon2-cffi cheroot googletrans gtts matplotlib numpy pillow pyopengl sip tornado webob
# run this command and inspect the output to confirm you're using the correct versions
pip install pyqt6 pyinstaller
export CODESIGN_IDENTITY="Devin Howard - Mnemosyne" # see note above about CODESIGN_IDENTITY
make clean
make macos
open dist/Mnemosyne.app
If you're planning on contributing more than one pull request using Git and Github, you might find https://hub.github.com to be a useful tool for managing your repositories, forks, pull requests, and branches.
If you want to hack on Mnemosyne and propose your changes for merging later ('pull request'), first create an account on, or log into, Github. Then, fork the project on Github. You now have your own copy of the Mnemosyne repository on Github.
To work with the code, you need to clone your personal Mnemosyne fork on Github fork to your local machine. It's best to setup ssh for Github, but you don't have to. Change to your working directory on the terminal and then clone your repository of Mnemosyne (in this example without ssh):
git clone https://github.com/<your-username>/mnemosyne.git
Let's also make it easy to track the official Mnemosyne repository:
git remote add upstream https://github.com/mnemosyne-proj/mnemosyne.git
It is best to create your own branches for your work:
git checkout -b <branch name>
Whenever you want, you can commit your changes:
git status
git add <files to add>
git commit -v
At some point you may want to share your changes with everyone. Before you do so, you should check make sure that you didn't introduce new test failures. Then, you should check if changes were made to the original Mnemosyne repository on Github. Your private fork on Github is not automatically updated with these changes. You can get the most recent changes like this:
git fetch upstream
git checkout master
git merge upstream/master
If there are new changes, your repository now looks like this (each number symbolises a commit):
your local master branch: ---1-2-3-4'-5'-6'-7'-8' (new changes from upstream)
|
your local feature branch: |-4-5-6 (your changes)
Before you push your branch, you should rebase it on master. Rebasing takes all the changes in your branch (in the figure: 4-5-6) and tries to apply them on top of the master branch, so that we end up with a linear history:
your local master branch: ---1-2-3-4'-5'-6'-7'-8' (new changes from upstream)
|
your local feature branch: |-4-5-6 (your changes)
Rebase like this:
git checkout <branch name>
git rebase master
Follow the instructions (git status
gives additional information).
Once you've successfully rebased your branch, push it to your Github account (we use --force
, because we want to overwrite the existing branch on our private Github account):
git push origin --force <branch name>
To create a pull request for your changes, go to the Mnemosyne project page on Github and click on the pull request tab. Click on 'New pull request' and follow the instructions.
Finally, some more background on the whole workflow can be found here.