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

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tatsumoto from gravatar.com tatsumoto

Unverified details

These details have not been verified by PyPI
Meta
  • License: GNU GENERAL PUBLIC LICENSE
  • Author: Ajatt-Tools and contributors
  • Requires: Python >=3.12
Classifiers
Report project as malware

Project description

gomi

Chat Channel Donate

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 to our collection by making a pull request.

Prerequisites

GNU/Linux

Install Python 3.12 or later if you haven't already.

Windows

Windows is not recommended because it is malware.

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

Installation

Install gomi using pipx: pipx install gomi.

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

Note: When using AJT Japanese, reopen the current profile to add the add-on's scripts to the note type after importing and after updating. Alternatively, open AJT Japanese's settings and press "Ok" ("Accept").

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 media && git commit

After committing your template, please create a pull request.

Caveats

Although gomi supports note types that reference external CSS and JS files stored in the collection.media folder, for example, by using <script src="_script.js"></script> in a Front or Back template, or by using @import url("_styling.css"); in the Styling section, there are a few caveats to keep in mind.

  • The filenames should begin with an underscore to prevent Anki from flagging them as unused.

  • If you use AnkiWeb to sync your collection with other devices (like an Android phone), external files will only sync once. If you change your externally linked CSS or JS file, you'll need to rename it so that updates are sent to your other devices. However, referencing external fonts is acceptable because they typically need to be synced only once.

  • Specifically, loading external JS files causes a slight flicker or lag whenever you flip a card. It is recommended that you use inline scripts instead:

    <script>
// some code
</script>

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for tatsumoto from gravatar.com tatsumoto

Unverified details

These details have not been verified by PyPI
Meta
  • License: GNU GENERAL PUBLIC LICENSE
  • Author: Ajatt-Tools and contributors
  • Requires: Python >=3.12
Classifiers

Release history Release notifications | RSS feed

This version

25.5.3.1

25.4.30.1

24.8.29.3

24.8.29.2

24.8.29.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gomi-25.5.3.1.tar.gz (37.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gomi-25.5.3.1-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

Details for the file gomi-25.5.3.1.tar.gz.

File metadata

  • Download URL: gomi-25.5.3.1.tar.gz
  • Upload date:
  • Size: 37.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for gomi-25.5.3.1.tar.gz
Algorithm Hash digest
SHA256 94965233da2885bb4dad9c3c559aac24fbb0d700412705f5d06e95df4841de68
MD5 ae76fe39ce5a122f6d87b6d51ce727bc
BLAKE2b-256 4dc03a1e7e06ceac480d16429c05c950920e6dd1f2a9b1163d54d971e2e6f40d

See more details on using hashes here.

Provenance

The following attestation bundles were made for gomi-25.5.3.1.tar.gz:

Publisher: ci-cd.yml on Ajatt-Tools/gomi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gomi-25.5.3.1-py3-none-any.whl.

File metadata

  • Download URL: gomi-25.5.3.1-py3-none-any.whl
  • Upload date:
  • Size: 38.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for gomi-25.5.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d9467ab819c443303426a21d99695e887c88d7e670d8ce7efe6a59492be30adc
MD5 c0dabcbba386e18a7f6f74967a9d9f51
BLAKE2b-256 4d517dccb963d3bb2c5de5727dbb8351d0cbfa399f94760c217da93332477742

See more details on using hashes here.

Provenance

The following attestation bundles were made for gomi-25.5.3.1-py3-none-any.whl:

Publisher: ci-cd.yml on Ajatt-Tools/gomi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page