Python SDK for interacting with Slite API
Project description
pySlite
Unofficial Python SDK for Slite API.
Installation
$ pip install pyslite
Usage
This SDK provides a simple way to interact with the Slite API. Here's how to use it:
from pyslite.client import Client
# Replace with your actual API key
api_key = "YOUR_SLITE_API_KEY"
client = Client(api_key)
# Get a note by ID
note = client.get_note("your_note_id")
if note:
print(f"Note Title: {note.title}")
print(f"Note Content: {note.content}") #Note content is markdown
else:
print("Failed to retrieve note.")
# Create a new note
response = client.create_note(
parent_note_id="your_parent_note_id",
template_id="your_template_id",
title="My New Note",
content="# My New Note\nThis is the content of my new note."
)
if response:
print(f"Note created successfully! Status code: {response.status_code}")
else:
print("Failed to create note.")
#Fetch all notes recursively under a given note.
all_notes = client.fetch_notes_recursive("your_root_note_id")
if all_notes:
for note in all_notes:
print(f"Note Title: {note.title}")
else:
print("Failed to fetch notes.")
Remember to replace "your_note_id", "your_parent_note_id", "your_template_id", and "your_root_note_id" with actual Slite note IDs.
Features
- Get Note: Retrieves a single note by its ID.
- Create Note: Creates a new note with specified parent, template, title, and markdown content.
- Fetch Notes Recursively: Retrieves a note and all its children recursively.
Error Handling
The library includes robust error handling. If a request fails, it will print an informative error message to the console and return None.
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyslite-0.0.10.tar.gz.
File metadata
- Download URL: pyslite-0.0.10.tar.gz
- Upload date:
- Size: 9.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8165569c1e64002925bce63eb3f02dda6ccab7b2a5a7cc3da8fb267329591921
|
|
| MD5 |
804b20a8e74db5c9cffea1fefb0c2a59
|
|
| BLAKE2b-256 |
9803c09f09d6a3bce27a5166327c941f98e5110123db5bf0df94876675987075
|
File details
Details for the file pyslite-0.0.10-py3-none-any.whl.
File metadata
- Download URL: pyslite-0.0.10-py3-none-any.whl
- Upload date:
- Size: 10.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e391d06991274a3ffd252106cea75f73b1c64d0b4389516b2bf786a8e6b47bd0
|
|
| MD5 |
6b413df96ee81439c83e09e7bf73d932
|
|
| BLAKE2b-256 |
c4b7a35283d01edc8097a30ccc6a393703eb606a488f35119ce1ca72ac9b8d6a
|