gomi 24.8.29.2

Package to store and manage Note Types for Anki in a git repository.

gomi

Gomi is a Python package used to store and manage Note Types for Anki in a git repository. At Ajatt-Tools, we store our note types here. Gomi provides a super user-friendly mechanism of importing and exporting note types, and everyone is welcome to add their templates by making a pull request.

Installation

GNU/Linux

1. Install Python 3.12 or later if you haven't already.
2. Install gomi using pipx: pipx install gomi.

Windows

Install Python from the Microsoft Store or check if you already have the good version putting on your file explorer search bar

%LOCALAPPDATA%\Microsoft\WindowsApps\python3

If you have the correct version, you can just close the python's window that just popped up.

Make sure to add python3 to the PATH. The path you need to add should look like C:\Users\[YourUsername]\AppData\Local\Microsoft\WindowsApps\python3.

If you don't have the python installed, when you'll put this command into the search bar, it will open a microsoft store window directly on the correct python version, and you just need to click Download.

After doing this step, you can make sure that everything is good by opening the command prompt with Windows+R, cmd and put the command:

python3 -m

If everything's good, you should get a response like : Argument expected for the -m option

Usage

Make sure Anki is running, and you have AnkiConnect installed.

Clone AnkiNoteTypes and cd into it. If you have never cloned a repository before, you need to install git. If you have git installed, open your terminal and type the following commands.

git clone "https://github.com/Ajatt-Tools/AnkiNoteTypes.git"
cd AnkiNoteTypes

Importing

To import one of the available Note Types to Anki, run:

gomi import

https://user-images.githubusercontent.com/69171671/143988488-ff70960c-840c-48e2-90d3-a24468da8942.mp4

Updating

If you imported a note type from the AJATT collection before, it received an update, and you want to import the new version, run:

gomi update

Exporting

To export one of your Note Types, run:

gomi export

Then write a helpful readme and commit your changes:

git add templates fonts && git commit

After committing your template, please create a pull request.