Doc samples autogenerator

[sosie-js]

I put the toy ankisync2_api.py in examples/
Play by yourself ^^

[patarapolw]

I don't really get how to use.

[sosie-js]

Well ankisync2_api.py generated the *_actions.py files already that are samples from anki-connect project which can be reused for your project as tests files.

These are:
deck-actions.py
card-actions.py
media-actions.py
note-actions.py
miscellaneous-actions.py
statistic-actions.py
graphical-actions.py
model-actions.py

and are matching the samples given on the foosoft website, ie Alex, the anki-connect author.

Let's try the first example of the desk-actions.py ,

1. copy the part of code which includes the head imports, and the invoke command
   and add an extra line print(result)

# test-action.py

from ankisync2.ankiconnect import  ankiconnect as invoke

        
"""
====================================
Gets the complete list of deck names for the current user.
====================================
"""
result = invoke("deckNames")
#See the result 
print('got list of decks: {}'.format(result))

2. Ensure you have installed anki-connect plugin in Anki by following Alex Installation steps

3. Open Anki either
   a) in Gui mode; anki (will use ~/.local/share/Anki2/User1/collection.anki2 database )
   or
   b) in syncserver mode : anki --syncserver (will use ~/.syncserver/collections-server.anki2 database )

4. trigger the python above to see the result.
   python3 test-action.py

NOTE: I have not yet tested all samples but it will a provide a good way to discover the API of
anki-connect thanks to your project I improved since. Of course, pytest can be used to validate the examples.

[patarapolw]

Regarding AnkiConnect, it would be hard to do in CI, anyway.

And ankisync2/ankiconnect.py is already a very simple script.