Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abdnh committed Nov 5, 2023
1 parent 22a76be commit 7763b22
Show file tree
Hide file tree
Showing 7 changed files with 100 additions and 48 deletions.
47 changes: 29 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2023-11-05

### Added

- The add-on now supports importing decks from [AnkiPro](https://ankipro.net). The add-on's name has been changed to "Copycat Importer" to reflect that.

### Fixed

- Fixed error when no database file path is chosen.

## [1.6.0] - 2023-09-23

### Added

- Added a graphical interface to make it easier to locate AnkiApp's data folder or database.
- The add-on now tries to detect AnkiApp's data folder on your system for you.
- The add-on now keeps some logs under th user_files/logs subfolder.
- Add the ability to extract misssing AnkiApp layouts from IndexedDB databases in the data folder. This is experimental and doesn't work currently on the latest Anki version (2.1.66) due to [an issue](https://github.com/abdnh/AnkiApp-importer/issues/5).
- Add the ability to extract misssing AnkiApp layouts from IndexedDB databases in the data folder. This is experimental and doesn't work currently on the latest Anki version (2.1.66) due to [an issue](https://github.com/abdnh/anki-copycat-importer/issues/5).

## [1.5.8] - 2023-09-20

Expand Down Expand Up @@ -127,20 +137,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Initial release

[1.6.0]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.8...1.6.0
[1.5.8]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.7...1.5.8
[1.5.7]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.6...1.5.7
[1.5.6]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.5...1.5.6
[1.5.5]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.4...1.5.5
[1.5.4]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.3...1.5.4
[1.5.3]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.2...1.5.3
[1.5.2]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.1...1.5.2
[1.5.1]: https://github.com/abdnh/AnkiApp-importer/compare/1.5.0...1.5.1
[1.5.0]: https://github.com/abdnh/AnkiApp-importer/compare/1.4.1...1.5.0
[1.4.1]: https://github.com/abdnh/AnkiApp-importer/compare/1.4.0...1.4.1
[1.4.0]: https://github.com/abdnh/AnkiApp-importer/compare/1.3.1...1.4.0
[1.3.1]: https://github.com/abdnh/AnkiApp-importer/compare/1.3.0...1.3.1
[1.3.0]: https://github.com/abdnh/AnkiApp-importer/compare/1.2.0...1.3.0
[1.2.0]: https://github.com/abdnh/AnkiApp-importer/compare/1.1.0...1.2.0
[1.1.0]: https://github.com/abdnh/AnkiApp-importer/compare/1.0.0...1.1.0
[1.0.0]: https://github.com/abdnh/AnkiApp-importer/releases/tag/1.0.0
[2.0.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.6.0...2.0.0
[1.6.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.8...1.6.0
[1.5.8]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.7...1.5.8
[1.5.7]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.6...1.5.7
[1.5.6]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.5...1.5.6
[1.5.5]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.4...1.5.5
[1.5.4]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.3...1.5.4
[1.5.3]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.2...1.5.3
[1.5.2]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.1...1.5.2
[1.5.1]: https://github.com/abdnh/anki-copycat-importer/compare/1.5.0...1.5.1
[1.5.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.4.1...1.5.0
[1.4.1]: https://github.com/abdnh/anki-copycat-importer/compare/1.4.0...1.4.1
[1.4.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.3.1...1.4.0
[1.3.1]: https://github.com/abdnh/anki-copycat-importer/compare/1.3.0...1.3.1
[1.3.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.2.0...1.3.0
[1.2.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.1.0...1.2.0
[1.1.0]: https://github.com/abdnh/anki-copycat-importer/compare/1.0.0...1.1.0
[1.0.0]: https://github.com/abdnh/anki-copycat-importer/releases/tag/1.0.0
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,59 @@
# AnkiApp Importer
# Copycat Importer

An [Anki](https://apps.ankiweb.net/) add-on to import decks from the copycat [AnkiApp](https://www.ankiapp.com/).
An [Anki](https://apps.ankiweb.net/) add-on to import decks from copycat apps such as [AnkiApp](https://www.ankiapp.com/) and [AnkiPro](https://ankipro.net/).

## AnkiApp

It appears that AnkiApp started to [paywall the deck export feature](https://www.reddit.com/r/Anki/comments/ocbhry/help_to_bypass_ankiapps_paywall_for_deck_export/).
So you can no longer export a zip of your cards [without paying](https://www.ankiapp.com/support/solutions/ddcf01b0/can-i-export-my-flashcards-from-ankiapp-/).

This add-on salvages the cards from the SQLite database and was inspired by the Reddit post linked above.
It can import cards, decks, note types, and media files.
This add-on salvages the cards from the SQLite database and was inspired by the Reddit post linked above. It can import cards, decks, note types, and media files.

![The add-on's dialog](images/dialog.png)
![AnkiApp Importer](images/ankiapp.png)

## How to Use
### Usage

- Download the add-on from https://ankiweb.net/shared/info/2072125761
- Make sure all your AnkiApp decks are downloaded before using the add-on. For that, go to AnkiApp, click on each of your decks, then click on the Download button at the bottom if it's shown.
- Run Anki and go to **Tools > Import From AnkiApp**. The add-on tries to detect AnkiApp's data folder on your system automatically. If you see the "Data folder" field already populated, you can go ahead and click Import. You can also specify a different folder location, or a single SQLite database file by checking the "Database file" option (only recommened if you don't have access to the whole data folder for some reason, as the add-on may need other files in the data folder to properly import notetypes).
- Run Anki and go to _Tools > Copycat Importer > Import from AnkiApp_. The add-on tries to detect AnkiApp's data folder on your system automatically. If you see the "Data folder" field already populated, you can go ahead and click Import. You can also specify a different folder location, or a single SQLite database file by checking the "Database file" option (only recommened if you don't have access to the whole data folder for some reason, as the add-on may need other files in the data folder to properly import notetypes).

## Notes & Known Issues
### Notes & Known Issues

- Study progress is not imported.
- AnkiApp doesn't seem to keep any info on the positions of note type fields, so an empty field will cause
Anki to refuse to import its note if it happened to be imported as the first field.
To prevent that, the add-on fills all empty fields with a non-breaking space.

## AnkiPro

![AnkiPro Importer](images/ankipro.png)

### Usage

The add-on works by downloading your decks from the AnkiPro site, so it needs your email and password. Go to _Tools > Copycat Importer > Import from AnkiPro_ and enter your account details.

### Notes & Known Issues

- Importing of [library decks](https://ankipro.net/library) is not supported. Since they are simply scraped from AnkiWeb, you can search and download the decks from [AnkiWeb](https://ankiweb.net/shared/decks) instead.
- Importing of study progress and deck options is not supported yet.

## Download

You can download the add-on from AnkiWeb: [2072125761](https://ankiweb.net/shared/info/2072125761)

## References

- [AnkiApp is not part of the Anki ecosystem - Frequently Asked Questions](https://faqs.ankiweb.net/ankiapp-is-not-part-of-the-anki-ecosystem.html) (with some notes about importing if you have a zip file)
- [Help to bypass Ankiapp's paywall for deck export : Anki | Reddit](https://www.reddit.com/r/Anki/comments/ocbhry/help_to_bypass_ankiapps_paywall_for_deck_export/)
- [AnkiApp - Support | Can I export my flashcards from AnkiApp?](https://www.ankiapp.com/support/solutions/ddcf01b0/can-i-export-my-flashcards-from-ankiapp-/)
- [AnkiPro: Another ripoff Anki app - AnkiMobile (iPhone/iPad) - Anki Forums](https://forums.ankiweb.net/t/ankipro-another-ripoff-anki-app/11791)

## 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/t/ankiapp-importer/16734/) or the [issue tracker](https://github.com/abdnh/AnkiApp-importer/issues).
Please post any questions, bug reports, or feature requests in the [support page](https://forums.ankiweb.net/t/ankiapp-importer/16734/) or the [issue tracker](https://github.com/abdnh/anki-copycat-importer/issues).

If you want priority support for your feature/help request, I'm available for hire.
You can get in touch from the aforementioned pages, via [email](mailto:[email protected]) or on [Fiverr](https://www.fiverr.com/abd_nh).
Expand Down
61 changes: 42 additions & 19 deletions ankiweb_page.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
This add-on allows you to import decks from the copycat <a href="https://www.ankiapp.com/">AnkiApp</a>.
It appears that AnkiApp started to <a href="https://www.reddit.com/r/Anki/comments/ocbhry/help_to_bypass_ankiapps_paywall_for_deck_export/">paywall the deck export feature</a>. So you can no longer export a zip of your cards <a href="https://www.ankiapp.com/support/solutions/ddcf01b0/can-i-export-my-flashcards-from-ankiapp-/">without paying</a>.
This add-on salvages the cards from the SQLite database and was inspired by the Reddit post linked above. It can import cards, decks, note types, and media files.
<p>This add-on allows you to import decks from copycat apps such as <a href="https://www.ankiapp.com/">AnkiApp</a> and <a href="https://ankipro.net/">AnkiPro</a>.</p>

<p><img src="https://raw.githubusercontent.com/abdnh/AnkiApp-importer/master/images/dialog.png" alt="The add-on's dialog"></p>
<b>AnkiApp</b>

<b>How to Use</b>
<p>It appears that AnkiApp started to <a href="https://www.reddit.com/r/Anki/comments/ocbhry/help_to_bypass_ankiapps_paywall_for_deck_export/">paywall the deck export feature</a>.
So you can no longer export a zip of your cards <a href="https://www.ankiapp.com/support/solutions/ddcf01b0/can-i-export-my-flashcards-from-ankiapp-/">without paying</a>.</p>
<p>This add-on salvages the cards from the SQLite database and was inspired by the Reddit post linked above. It can import cards, decks, note types, and media files.</p>
<p><img src="https://raw.githubusercontent.com/abdnh/anki-copycat-importer/ankipro/images/ankiapp.png" alt="AnkiApp Importer"></p>

<b>Usage</b>

<ul>
<li>Make sure all your AnkiApp decks are downloaded before using the add-on. For that, go to AnkiApp, click on each of your decks, then click on the Download button at the bottom if it's shown.</li>
<li>Run Anki and go to <b>Tools &gt; Import From AnkiApp</b>. The add-on tries to detect AnkiApp's data folder on your system automatically. If you see the "Data folder" field already populated, you can go ahead and click Import. You can also specify a different folder location, or a single SQLite database file by checking the "Database file" option (only recommened if you don't have access to the whole data folder for some reason, as the add-on may need other files in the data folder to properly import notetypes).</li>
<li>Make sure all your AnkiApp decks are downloaded before using the add-on. For that, go to AnkiApp, click on each of your decks, then click on the Download button at the bottom if it's shown.</li>
<li>Run Anki and go to <i>Tools &gt; Copycat Importer &gt; Import from AnkiApp</i>. The add-on tries to detect AnkiApp's data folder on your system automatically. If you see the "Data folder" field already populated, you can go ahead and click Import. You can also specify a different folder location, or a single SQLite database file by checking the "Database file" option (only recommened if you don't have access to the whole data folder for some reason, as the add-on may need other files in the data folder to properly import notetypes).</li>
</ul>

<b>Notes &amp; Known Issues</b>
Expand All @@ -20,25 +23,45 @@
To prevent that, the add-on fills all empty fields with a non-breaking space.</li>
</ul>

<b>References</b>
<b>AnkiPro</b>

<ul><li><a href="https://faqs.ankiweb.net/ankiapp-is-not-part-of-the-anki-ecosystem.html">AnkiApp is not part of the Anki ecosystem - Frequently Asked Questions</a> (with some notes about importing if you have a zip file)</li><li><a href="https://www.reddit.com/r/Anki/comments/ocbhry/help_to_bypass_ankiapps_paywall_for_deck_export/">Help to bypass Ankiapp's paywall for deck export : Anki | Reddit</a></li><li><a href="https://www.ankiapp.com/support/solutions/ddcf01b0/can-i-export-my-flashcards-from-ankiapp-/">AnkiApp - Support | Can I export my flashcards from AnkiApp?</a></li></ul>
<p><img src="https://raw.githubusercontent.com/abdnh/anki-copycat-importer/ankipro/images/ankipro.png" alt="AnkiPro Importer"></p>

<b>Changelog</b>
<b>Usage</b>

See <a href="https://github.com/abdnh/AnkiApp-importer/blob/master/CHANGELOG.md">CHANGELOG.md</a> for a list of changes.
<p>The add-on works by downloading your decks from the AnkiPro site, so it needs your email and password. Go to <i>Tools &gt; Copycat Importer &gt; Import from AnkiPro</i> and enter your account details.</p>

<b>Support & feature requests</b>
<b>Notes &amp; Known Issues</b>

Please post any questions, bug reports, or feature requests in the <a href="https://forums.ankiweb.net/t/ankiapp-importer/16734/">support page</a> or the <a href="https://github.com/abdnh/AnkiApp-importer/issues">issue tracker</a>.
If you want priority support for your feature/help request, I'm available for hire. You can get in touch from the aforementioned pages, via <a href="mailto:[email protected]">email</a> or on <a href="https://www.fiverr.com/abd_nh">Fiverr</a>.
<ul>
<li>Importing of <a href="https://ankipro.net/library">library decks</a> is not supported. Since they are simply scraped from AnkiWeb, you can search and download the decks from <a href="https://ankiweb.net/shared/decks">AnkiWeb</a> instead.</li>
<li>Importing of study progress and deck options is not supported yet.</li>
</ul>

<b>Support me</b>
<b>References</b>

Consider supporting me if you like my work:
<ul>
<li><a href="https://faqs.ankiweb.net/ankiapp-is-not-part-of-the-anki-ecosystem.html">AnkiApp is not part of the Anki ecosystem - Frequently Asked Questions</a> (with some notes about importing if you have a zip file)</li>
<li><a href="https://www.reddit.com/r/Anki/comments/ocbhry/help_to_bypass_ankiapps_paywall_for_deck_export/">Help to bypass Ankiapp's paywall for deck export : Anki | Reddit</a></li>
<li><a href="https://www.ankiapp.com/support/solutions/ddcf01b0/can-i-export-my-flashcards-from-ankiapp-/">AnkiApp - Support | Can I export my flashcards from AnkiApp?</a></li>
<li><a href="https://forums.ankiweb.net/t/ankipro-another-ripoff-anki-app/11791">AnkiPro: Another ripoff Anki app - AnkiMobile (iPhone/iPad) - Anki Forums</a></li>
</ul>

<b>Changelog</b>

<a href="https://github.com/sponsors/abdnh"><img height='36' src="https://i.imgur.com/dAgtzcC.png"></a><a href="https://www.patreon.com/abdnh"><img height="36" src="https://i.imgur.com/mZBGpZ1.png"></a><a href="https://www.buymeacoffee.com/abdnh" target="_blank"><img height="36" src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee"></a>
<p>See <a href="https://github.com/abdnh/anki-copycat-importer/blob/ankipro/CHANGELOG.md">CHANGELOG.md</a> for a list of changes.</p>

I'm also available for freelance add-on development on Fiverr:
<b>Support &amp; feature requests</b>

<p>Please post any questions, bug reports, or feature requests in the <a href="https://forums.ankiweb.net/t/ankiapp-importer/16734/">support page</a> or the <a href="https://github.com/abdnh/anki-copycat-importer/issues">issue tracker</a>.</p>
<p>If you want priority support for your feature/help request, I'm available for hire.
You can get in touch from the aforementioned pages, via <a href="mailto:[email protected]">email</a> or on <a href="https://www.fiverr.com/abd_nh">Fiverr</a>.</p>

<b>Support me</b>

<a href="https://www.fiverr.com/abd_nh/develop-an-anki-addon"><img height='36' src="https://i.imgur.com/0meG4dk.png"></a>
<p>Consider supporting me if you like my work:</p>
<p><a href="https://github.com/sponsors/abdnh"><img height="36" src="https://i.imgur.com/dAgtzcC.png"></a>
<a href="https://www.patreon.com/abdnh"><img height="36" src="https://i.imgur.com/mZBGpZ1.png"></a>
<a href="https://www.buymeacoffee.com/abdnh" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" style="height: 36px"></a></p>
<p>I'm also available for freelance add-on development on Fiverr:</p>
<p><a href="https://www.fiverr.com/abd_nh/develop-an-anki-addon"><img height="36" src="https://i.imgur.com/0meG4dk.png"></a></p>
Binary file added images/ankiapp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ankipro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/dialog.png
Binary file not shown.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ package-dir = { "AnkiAppImporter" = "src" }
[tool.setuptools_scm]

[project.urls]
Repository = "https://github.com/abdnh/AnkiApp-importer/"
Repository = "https://github.com/abdnh/anki-copycat-importer/"

0 comments on commit 7763b22

Please sign in to comment.