Update move export to misc, fix return
This commit is contained in:
parent
496db484c5
commit
0f8b402d73
91
README.md
91
README.md
@ -1,11 +1,11 @@
|
|||||||
# AnkiConnect #
|
# AnkiConnect
|
||||||
|
|
||||||
The AnkiConnect plugin enables external applications such as [Yomichan](https://foosoft.net/projects/yomichan/) to communicate with
|
The AnkiConnect plugin enables external applications such as [Yomichan](https://foosoft.net/projects/yomichan/) to communicate with
|
||||||
[Anki](https://apps.ankiweb.net/) over a network interface. This software makes it possible to execute queries against
|
[Anki](https://apps.ankiweb.net/) over a network interface. This software makes it possible to execute queries against
|
||||||
the user's card deck, automatically create new vocabulary and Kanji flash cards, and more. AnkiConnect is compatible
|
the user's card deck, automatically create new vocabulary and Kanji flash cards, and more. AnkiConnect is compatible
|
||||||
with the latest stable (2.1.x) releases of Anki; older versions (2.0.x and below) are no longer supported.
|
with the latest stable (2.1.x) releases of Anki; older versions (2.0.x and below) are no longer supported.
|
||||||
|
|
||||||
## Table of Contents ##
|
## Table of Contents
|
||||||
|
|
||||||
* [Installation](https://foosoft.net/projects/anki-connect/#installation)
|
* [Installation](https://foosoft.net/projects/anki-connect/#installation)
|
||||||
* [Notes for Windows Users](https://foosoft.net/projects/anki-connect/#notes-for-windows-users)
|
* [Notes for Windows Users](https://foosoft.net/projects/anki-connect/#notes-for-windows-users)
|
||||||
@ -22,7 +22,7 @@ with the latest stable (2.1.x) releases of Anki; older versions (2.0.x and below
|
|||||||
* [Graphical](https://foosoft.net/projects/anki-connect/#graphical)
|
* [Graphical](https://foosoft.net/projects/anki-connect/#graphical)
|
||||||
* [Export](https://foosoft.net/projects/anki-connect/#export)
|
* [Export](https://foosoft.net/projects/anki-connect/#export)
|
||||||
|
|
||||||
## Installation ##
|
## Installation
|
||||||
|
|
||||||
The installation process is similar to that of other Anki plugins and can be accomplished in three steps:
|
The installation process is similar to that of other Anki plugins and can be accomplished in three steps:
|
||||||
|
|
||||||
@ -34,13 +34,13 @@ Anki must be kept running in the background in order for other applications to b
|
|||||||
verify that AnkiConnect is running at any time by accessing [localhost:8765](http://localhost:8765) in your browser. If
|
verify that AnkiConnect is running at any time by accessing [localhost:8765](http://localhost:8765) in your browser. If
|
||||||
the server is running, you should see the message `AnkiConnect v.6` displayed in your browser window.
|
the server is running, you should see the message `AnkiConnect v.6` displayed in your browser window.
|
||||||
|
|
||||||
### Notes for Windows Users ###
|
### Notes for Windows Users
|
||||||
|
|
||||||
Windows users may see a firewall nag dialog box appear on Anki startup. This occurs because AnkiConnect hosts a local
|
Windows users may see a firewall nag dialog box appear on Anki startup. This occurs because AnkiConnect hosts a local
|
||||||
server in order to enable other applications to connect to it. The host application, Anki, must be unblocked for this
|
server in order to enable other applications to connect to it. The host application, Anki, must be unblocked for this
|
||||||
plugin to function correctly.
|
plugin to function correctly.
|
||||||
|
|
||||||
### Notes for Mac OS X Users ###
|
### Notes for Mac OS X Users
|
||||||
|
|
||||||
Starting with [Mac OS X Mavericks](https://en.wikipedia.org/wiki/OS_X_Mavericks), a feature named *App Nap* has been
|
Starting with [Mac OS X Mavericks](https://en.wikipedia.org/wiki/OS_X_Mavericks), a feature named *App Nap* has been
|
||||||
introduced to the operating system. This feature causes certain applications which are open (but not visible) to be
|
introduced to the operating system. This feature causes certain applications which are open (but not visible) to be
|
||||||
@ -56,7 +56,7 @@ foreground, App Nap should be disabled for Anki:
|
|||||||
```
|
```
|
||||||
3. Restart Anki.
|
3. Restart Anki.
|
||||||
|
|
||||||
## Application Interface for Developers ##
|
## Application Interface for Developers
|
||||||
|
|
||||||
AnkiConnect exposes Anki features to external applications via an easy to use
|
AnkiConnect exposes Anki features to external applications via an easy to use
|
||||||
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API. After it is installed, this plugin will
|
[RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API. After it is installed, this plugin will
|
||||||
@ -68,7 +68,7 @@ access it from the same host on which it is running. If you need to access it ov
|
|||||||
environment variable `ANKICONNECT_BIND_ADDRESS` to change the binding address. For example, you can set it to `0.0.0.0`
|
environment variable `ANKICONNECT_BIND_ADDRESS` to change the binding address. For example, you can set it to `0.0.0.0`
|
||||||
in order to bind it to all network interfaces on your host.
|
in order to bind it to all network interfaces on your host.
|
||||||
|
|
||||||
### Sample Invocation ###
|
### Sample Invocation
|
||||||
|
|
||||||
Every request consists of a JSON-encoded object containing an `action`, a `version`, contextual `params`, and a `key`
|
Every request consists of a JSON-encoded object containing an `action`, a `version`, contextual `params`, and a `key`
|
||||||
value used for authentication (which is optional and can be omitted by default). AnkiConnect will respond with an object
|
value used for authentication (which is optional and can be omitted by default). AnkiConnect will respond with an object
|
||||||
@ -96,13 +96,13 @@ response will only contain the value of the `result`; no `error` field is availa
|
|||||||
You can use whatever language or tool you like to issue request to AnkiConnect, but a couple of simple examples are
|
You can use whatever language or tool you like to issue request to AnkiConnect, but a couple of simple examples are
|
||||||
included below as reference.
|
included below as reference.
|
||||||
|
|
||||||
#### Curl ####
|
#### Curl
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl localhost:8765 -X POST -d "{\"action\": \"deckNames\", \"version\": 6}"
|
curl localhost:8765 -X POST -d "{\"action\": \"deckNames\", \"version\": 6}"
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Python ####
|
#### Python
|
||||||
|
|
||||||
```python
|
```python
|
||||||
import json
|
import json
|
||||||
@ -129,7 +129,7 @@ result = invoke('deckNames')
|
|||||||
print('got list of decks: {}'.format(result))
|
print('got list of decks: {}'.format(result))
|
||||||
```
|
```
|
||||||
|
|
||||||
#### JavaScript ####
|
#### JavaScript
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
function invoke(action, version, params={}) {
|
function invoke(action, version, params={}) {
|
||||||
@ -167,7 +167,7 @@ const result = await invoke('deckNames', 6);
|
|||||||
console.log(`got list of decks: ${result}`);
|
console.log(`got list of decks: ${result}`);
|
||||||
```
|
```
|
||||||
|
|
||||||
### Supported Actions ###
|
### Supported Actions
|
||||||
|
|
||||||
Below is a comprehensive list of currently supported actions. Note that deprecated APIs will continue to function
|
Below is a comprehensive list of currently supported actions. Note that deprecated APIs will continue to function
|
||||||
despite not being listed on this page as long as your request is labeled with a version number corresponding to when the
|
despite not being listed on this page as long as your request is labeled with a version number corresponding to when the
|
||||||
@ -176,7 +176,7 @@ API was available for use.
|
|||||||
This page currently documents **version 6** of the API. Make sure to include this version number in your requests to
|
This page currently documents **version 6** of the API. Make sure to include this version number in your requests to
|
||||||
guarantee that your application continues to function properly in the future.
|
guarantee that your application continues to function properly in the future.
|
||||||
|
|
||||||
#### Miscellaneous ####
|
#### Miscellaneous
|
||||||
|
|
||||||
* **version**
|
* **version**
|
||||||
|
|
||||||
@ -297,7 +297,33 @@ guarantee that your application continues to function properly in the future.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Decks ####
|
* **exportPackage**
|
||||||
|
|
||||||
|
Exports a given deck in `.apkg` format. Returns `true` if successful or `false` otherwise. The optional property
|
||||||
|
`includeSched` (default is `false`) can be specified to include the cards' scheduling data.
|
||||||
|
|
||||||
|
*Sample request*:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"action": "exportPackage",
|
||||||
|
"version": 6,
|
||||||
|
"params": {
|
||||||
|
"deck": "Default",
|
||||||
|
"path": "/data/Deck.apkg",
|
||||||
|
"includeSched": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
*Sample result*:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"result": true,
|
||||||
|
"error": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Decks
|
||||||
|
|
||||||
* **deckNames**
|
* **deckNames**
|
||||||
|
|
||||||
@ -629,7 +655,7 @@ guarantee that your application continues to function properly in the future.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Models ####
|
#### Models
|
||||||
|
|
||||||
* **modelNames**
|
* **modelNames**
|
||||||
|
|
||||||
@ -941,7 +967,7 @@ guarantee that your application continues to function properly in the future.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Notes ####
|
#### Notes
|
||||||
|
|
||||||
* **addNote**
|
* **addNote**
|
||||||
|
|
||||||
@ -1265,7 +1291,7 @@ guarantee that your application continues to function properly in the future.
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
#### Cards ####
|
#### Cards
|
||||||
|
|
||||||
* **suspend**
|
* **suspend**
|
||||||
|
|
||||||
@ -1513,7 +1539,7 @@ guarantee that your application continues to function properly in the future.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Media ####
|
#### Media
|
||||||
|
|
||||||
* **storeMediaFile**
|
* **storeMediaFile**
|
||||||
|
|
||||||
@ -1613,7 +1639,7 @@ guarantee that your application continues to function properly in the future.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Graphical ####
|
#### Graphical
|
||||||
|
|
||||||
* **guiBrowse**
|
* **guiBrowse**
|
||||||
|
|
||||||
@ -1887,32 +1913,3 @@ guarantee that your application continues to function properly in the future.
|
|||||||
"error": null
|
"error": null
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Export ###
|
|
||||||
|
|
||||||
* **exportPackage**
|
|
||||||
|
|
||||||
Exports a given deck in .apkg format. Returns `true` if successful or `false` otherwise.
|
|
||||||
The optional property `includeSched` (default is `false`) can be specified to include the
|
|
||||||
cards' scheduling data.
|
|
||||||
|
|
||||||
*Sample request*:
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"action": "exportPackage",
|
|
||||||
"version": 6,
|
|
||||||
"params": {
|
|
||||||
"deck": "Default",
|
|
||||||
"path": "/data/Deck.apkg",
|
|
||||||
"includeSched": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
*Sample result*:
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"result": true,
|
|
||||||
"error": null
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
@ -1201,19 +1201,12 @@ class AnkiConnect:
|
|||||||
|
|
||||||
@util.api()
|
@util.api()
|
||||||
def exportPackage(self, deck, path, includeSched=False):
|
def exportPackage(self, deck, path, includeSched=False):
|
||||||
results = []
|
|
||||||
results.append(self.createPackage(deck, path, includeSched))
|
|
||||||
|
|
||||||
return results
|
|
||||||
|
|
||||||
|
|
||||||
def createPackage(self, deck, path, includeSched):
|
|
||||||
collection = self.collection()
|
collection = self.collection()
|
||||||
if collection is not None:
|
if collection is not None:
|
||||||
deck = collection.decks.byName(deck)
|
deck = collection.decks.byName(deck)
|
||||||
if deck is not None:
|
if deck is not None:
|
||||||
exporter = AnkiPackageExporter(collection)
|
exporter = AnkiPackageExporter(collection)
|
||||||
exporter.did = deck["id"]
|
exporter.did = deck['id']
|
||||||
exporter.includeSched = includeSched
|
exporter.includeSched = includeSched
|
||||||
exporter.exportInto(path)
|
exporter.exportInto(path)
|
||||||
return True
|
return True
|
||||||
|
@ -1,21 +0,0 @@
|
|||||||
#!/usr/bin/env python
|
|
||||||
|
|
||||||
import os
|
|
||||||
import tempfile
|
|
||||||
import unittest
|
|
||||||
|
|
||||||
import util
|
|
||||||
|
|
||||||
|
|
||||||
class TestExport(unittest.TestCase):
|
|
||||||
def runTest(self):
|
|
||||||
fd, newname = tempfile.mkstemp(prefix="testexport", suffix=".apkg")
|
|
||||||
os.close(fd)
|
|
||||||
os.unlink(newname)
|
|
||||||
success = util.invoke('exportPackage', deck='Default', path=newname)
|
|
||||||
self.assertTrue(success)
|
|
||||||
self.assertTrue(os.path.exists(newname))
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
unittest.main()
|
|
@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
import os
|
||||||
|
import tempfile
|
||||||
import unittest
|
import unittest
|
||||||
import util
|
import util
|
||||||
|
|
||||||
@ -24,6 +26,14 @@ class TestMisc(unittest.TestCase):
|
|||||||
result = util.invoke('getNumCardsReviewedToday')
|
result = util.invoke('getNumCardsReviewedToday')
|
||||||
self.assertIsInstance(result, int)
|
self.assertIsInstance(result, int)
|
||||||
|
|
||||||
|
# exportPackage
|
||||||
|
fd, newname = tempfile.mkstemp(prefix='testexport', suffix='.apkg')
|
||||||
|
os.close(fd)
|
||||||
|
os.unlink(newname)
|
||||||
|
result = util.invoke('exportPackage', deck='Default', path=newname)
|
||||||
|
self.assertTrue(result)
|
||||||
|
self.assertTrue(os.path.exists(newname))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
Loading…
Reference in New Issue
Block a user