additional documentation for libsql sync example #102
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the documentation and example for using libSQL with a synced Turso database. The updates make setup clearer and replaces command line environment variables with a
.env
file for easier configuration.Changes
README.md
python-dotenv
dependency to support loading.env
file..env
file are needed.turso db create
,turso db show
, andturso db tokens create
..env
file snippet.python3 main.py
and a '.env' file in place of inline environment variables.main.py
from dotenv import load_dotenv
andload_dotenv()
for compatibility with '.env' file.Motivation
The original example was functional but assumed prior knowledge that could frustrate new users:
Because embedded sync is a common entry point for developers new to libSQL and Turso, this update improves usability by:
.env
support viapython-dotenv
to align with Python best practices for managing credentials.Testing
.env
file with validTURSO_DATABASE_URL
andTURSO_AUTH_TOKEN
values.users
table is created, and expected query results are printed.