• v0.1.0 9bc025a661

    kerkmann released this 2023-06-29 19:44:30 +00:00 | 38 commits to main since this release

    I'm thrilled to announce the first release of AnkiBridge (v0.1.0)! AnkiBridge is a Rust library designed to seamlessly integrate your Rust code with the Anki application. Acting as a bridge, it facilitates HTTP communication and enables smooth data transmission with Anki.

    Key Features

    • Connection Establishment: AnkiBridge allows you to establish a connection with Anki through the AnkiConnect add-on.
    • Flexible Actions: Perform a wide range of actions with Anki, including card and deck operations, providing you with full control over your flashcards.
    • Data Retrieval: Retrieve comprehensive data and statistics from Anki, empowering you to gather valuable insights and information.
    • Programmatic Interactions: Interact with flashcards and decks programmatically, enabling automated processes and customized workflows.

    Getting Started

    To start using AnkiBridge, follow these simple steps:

    1. Install the AnkiConnect add-on in your Anki application. Open Anki, go to the "Tools" menu, select "Add-ons," click on "Get Add-ons," and enter the Add-on ID: 2055492159.

    2. Add the following line to your Cargo.toml file:

      [dependencies]
      anki_bridge = { version = "0.1.0", features = ["ureq"]}
      

      Ensure that you have the ureq feature enabled in your dependencies.

    3. Refer to the documentation and examples provided to learn how to establish a connection, perform actions, and retrieve data from Anki.

    Roadmap

    AnkiBridge is an actively developed project, and we have an exciting roadmap ahead. Here are some of the planned features for future releases:

    • Graphical Actions: Implement graphical interactions to enhance user experience.
    • Media Actions: Add support for managing media assets within Anki.
    • Miscellaneous Actions: Expand the range of available actions to cover miscellaneous operations.
    • Model Actions: Provide functionality for working with note types and models in Anki.
    • Note Actions: Enable operations related to notes, such as creation, modification, and deletion.
    • Statistic Actions: Enhance the ability to retrieve and analyze statistics from Anki.

    We welcome contributions from the community! If you encounter any issues, have suggestions, or would like to contribute, please visit our GitLab repository to open an issue or submit a pull request.

    Downloads