Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gsejas/mochi-api-client
Python wrapper for the Mochi spaced repetition platform
https://github.com/gsejas/mochi-api-client
Last synced: 5 days ago
JSON representation
Python wrapper for the Mochi spaced repetition platform
- Host: GitHub
- URL: https://github.com/gsejas/mochi-api-client
- Owner: GSejas
- License: apache-2.0
- Created: 2024-02-22T10:39:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-18T07:02:35.000Z (2 months ago)
- Last Synced: 2025-01-18T13:33:29.409Z (9 days ago)
- Language: Python
- Size: 102 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mochi API Client
The Mochi API Client is a Python library designed to simplify interacting with the Mochi API, allowing developers to easily create, retrieve, update, and delete cards and decks within their Python applications.
Features
- Simplified access to the Mochi API endpoints
- Methods for managing cards, decks, and templates
- Support for custom fields and attachments in cards
- Easy to integrate with Python applications
## Installation
Install the Mochi API Client using pip:
```sh
pip install mochi-api-client
```
# Quick Start
Here's a quick example to get you started:
```python
from mochi.client import Mochi
from mochi.auth import Auth
auth = Auth.Token("find api token in mochi settings page")
mochi = Mochi(auth=auth)
# list decks
decks = mochi.decks.list_decks()
print(decks)
if len(decks) < 1:
# Working with decks
new_deck = mochi.decks.create_deck(name="My new deck")
print(new_deck)
# Working with cards
new_card = mochi.cards.create_card("New card content", (decks[0])["id"])
print(new_card)
# Working with templates
templates = mochi.templates.list_templates()
print(templates)
mochi.close()
```
## Diagrams
### Sequence Diagram
A sequence diagram to show the interaction between the client and the API when creating a new card.
## Sequence Diagram for Creating a Card
```mermaid
sequenceDiagram
participant User
participant MochiClient as Mochi Client
participant CardsAPI as Cards API
User->>MochiClient: create_card(content, deck_id, kwargs)
MochiClient->>CardsAPI: POST /cards
CardsAPI-->>MochiClient: 201 Created
MochiClient-->>User: New card details
```
## Class Diagram
```mermaid
classDiagram
class Mochi {
-session: Session
-cards: Cards
-decks: Decks
-templates: Templates
+__init__(auth: Auth, base_url: str)
+close()
}
class Auth {
+Token(api_key: str)
}
class Cards {
+__init__(session: Session, base_url: str)
+create_card(content: str, deck_id: str, kwargs: dict)
+get_card(card_id: str)
+update_card(card_id: str, kwargs: dict)
+delete_card(card_id: str)
+list_cards(deck_id: str)
}
class Decks {
+__init__(session: Session, base_url: str)
+create_deck(name: str, kwargs: dict)
+get_deck(deck_id: str)
+update_deck(deck_id: str, kwargs: dict)
+delete_deck(deck_id: str)
+list_decks()
}
class Templates {
+__init__(session: Session, base_url: str)
+get_template(template_id: str)
+list_templates()
}
Mochi --> Auth
Mochi --> Cards
Mochi --> Decks
Mochi --> Templates
```
## Documentation
For detailed documentation on all available methods and their parameters, visit Mochi API Documentation.
## Contributing
Contributions are welcome! Please read our Contributing Guide for details on how to submit pull requests, report issues, and suggest improvements.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Support
If you encounter any problems or have suggestions, please file an issue on the GitHub issue tracker.