Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajatt-tools/gomi
🍈 Package to store and manage Note Types for Anki in a git repository.
https://github.com/ajatt-tools/gomi
ajatt anki
Last synced: 3 months ago
JSON representation
🍈 Package to store and manage Note Types for Anki in a git repository.
- Host: GitHub
- URL: https://github.com/ajatt-tools/gomi
- Owner: Ajatt-Tools
- License: gpl-3.0
- Created: 2024-08-29T18:37:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-03T23:23:46.000Z (4 months ago)
- Last Synced: 2024-10-09T12:43:43.507Z (3 months ago)
- Topics: ajatt, anki
- Language: Python
- Homepage: https://tatsumoto.neocities.org/blog/join-our-community
- Size: 546 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# gomi
[](https://tatsumoto-ren.github.io/blog/join-our-community.html)
[](https://t.me/ajatt_tools)
[](https://tatsumoto.neocities.org/blog/donating-to-tatsumoto)
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](https://github.com/Ajatt-Tools/AnkiNoteTypes).
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](https://wiki.archlinux.org/title/Python) 3.12 or later if you haven't already.
### Windows
Windows is not recommended [because it is malware](https://www.gnu.org/proprietary/malware-microsoft.html).
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](https://pypi.org/project/gomi/) using [pipx](https://pipx.pypa.io/): `pipx install gomi`.
## Usage
Make sure Anki is running, and you have
[AnkiConnect](https://ankiweb.net/shared/info/2055492159)
installed.
Clone [AnkiNoteTypes](https://github.com/Ajatt-Tools/AnkiNoteTypes) and `cd` into it.
If you have never cloned a repository before,
you need to install [git](https://git-scm.com/).
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](https://github.com/Ajatt-Tools/AnkiNoteTypes/tree/main/templates)
to Anki, run:
```
gomi import
```
### 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](https://github.com/Ajatt-Tools/AnkiNoteTypes/pulls).