https://github.com/abdnh/anki-addon-template

Anki add-on template for my projects
https://github.com/abdnh/anki-addon-template

anki anki-addon

Last synced: about 2 months ago
JSON representation

Anki add-on template for my projects

• Host: GitHub
• URL: https://github.com/abdnh/anki-addon-template
• Owner: abdnh
• License: agpl-3.0
• Created: 2023-03-29T00:14:29.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T14:53:39.000Z (4 months ago)
• Last Synced: 2024-09-09T17:56:55.415Z (4 months ago)
• Topics: anki, anki-addon
• Language: Python
• Homepage:
• Size: 97.7 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Anki Add-on Template

Anki add-on template for my projects.

## Structure

-   My [ankiscripts](https://github.com/abdnh/ankiscripts) project is used for various tasks, such as setting up dev environment, packaging, and updating dependencies.

-   Source files are in the [src](src) folder. The add-on zip contains all contents of this folder.

-   Qt Designer files (if any) are in [designer](designer) folder. Generated Python forms are written to src/forms.

-   An [addon.json](addon.json) file is used for metadata, similar to [Glutanimate's add-on builder](https://github.com/glutanimate/anki-addon-builder). [manifest.json](https://addon-docs.ankiweb.net/sharing.html#sharing-outside-ankiweb) is produced from this file.

-   [pylint](.pylintrc), [mypy](mypy.ini), black, and [isort](.isort.cfg) are used for linting and formatting.

-   Tests are in the [tests](tests) folder.

-   a [Makefile](Makefile) is used to run build & lint commands.

-   Requirements are specified in \*.in files inside the [requirements](requirements) subfolder. [pip-tools](https://github.com/jazzband/pip-tools) is used to update and pin dependencies, generating corresponding .txt files.

-   [CHANGELOG.md](CHANGELOG.md) follows the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.

-   The description for the AnkiWeb listing is in [ankiweb_page.html](ankiweb_page.html). [ankiwebify-readme](https://github.com/abdnh/ankiwebify-readme) can be used to convert some sections of README.md to the HTML accepted by AnkiWeb.

-   The add-on is [licensed](LICENSE) under [GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/).

**_Below sections are what should be modified and included in the actual add-on's README.md._**

[BEGINNING OF TEMPLATE]

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a list of changes.

## Support & feature requests

Please post any questions, bug reports, or feature requests in the [support page](https://forums.ankiweb.net/c/add-ons/11) or the [issue tracker](https://github.com/abdnh/anki-addon-template/issues).

If you want priority support for your feature/help request, I'm available for hire.

Get in touch via [email](mailto:[email protected]) or the UpWork link below.

## Support me

Consider supporting me if you like my work:







I'm also available for freelance add-on development: