Bosc
Bosc is a document store that provides an easy, Pythonic interface for handling documents stored on the local file system. It utilizes the full power of SQLite for storing and querying documents and employs Pydantic as the parsing and validation engine, ensuring it works seamlessly within the modern Python ecosystem, including FastAPI.
⚠️ Bosc is not an ORM for SQLite. It is a document-oriented store that uses SQLite as a backend. It is not designed to replace traditional SQL databases, but rather to provide a simple, Pythonic interface for working with flexible documents.
Installation
Before you begin, ensure you have Python installed on your system. This document store requires Python 3.8 or newer.
You can install Bosc using pip:
pip install bosc
Quickstart
Defining a Document Model
from bosc import Document
class User(Document):
name: str
age: int
# Specify the database path for this document
bosc_database_path = "my_database.db"
# Specify the collection name for this document (Optional)
bosc_collection_name = "users"
Inserting Documents
user = User(name="John Doe", age=30)
user.insert() # Insert the document into the database
# Inserting multiple documents
User.insert_many([
User(name="Jane Doe", age=25),
User(name="Alice", age=35),
])
Querying Documents
# Find all users
users = User.find()
# Find users with specific criteria
johns = User.find(User.name == "John Doe")
young_users = User.find(User.age < 30)
# Find users with multiple criteria
users = User.find(User.name == "John Doe", User.age > 30)
# Find having order by
users = User.find(
User.name == "John Doe",
order_by="age",
order_direction=OrderDirection.ASC
)
# Find with limit
users = User.find(User.name == "John Doe", limit=1)
# Find with offset
users = User.find(User.name == "John Doe", offset=1)
# Find a single user
jane = User.find_one(User.name == "Jane Doe")
Updating Documents
# Update all users named John Doe to have age 31
User.update(User.name == "John Doe", Set("age", 31))
# Update a single document
john = User.find_one(User.name == "John Doe")
john.age = 32
john.save() # This uses the OnConflict.REPLACE strategy
Deleting Documents
# Delete a specific user
jane.delete()
# Delete all users named Alice
User.delete_many(User.name == "Alice")
Advanced Usage
Working with Indexes
To improve query performance, you can define indexes on your document fields.
from bosc import Document, Index, IndexType
class User(Document):
name: str
age: int
bosc_indexes = [
Index("name", IndexType.UNIQUE),
Index("age", IndexType.PATH),
]
bosc_database_path = "my_database.db"
# Sync indexes with the database
User.sync_indexes()
This will create indexes on the name and age fields of the User documents, assuming Index and IndexType are properly defined and imported from the bosc package.
Complex Queries
Leverage the full power of queries with complex conditions and ordering.
from bosc import And, Or
from bosc import OrderDirection
# Find users named John Doe over 30 years old
users = User.find(And(User.name == "John Doe", User.age > 30))
# Find users either named Alice or younger than 25
users = User.find(Or(User.name == "Alice", User.age < 25))
# Order users by age
users = User.find(order_by="age", order_direction=OrderDirection.ASC)
Metadata
Release files for bosc 0.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bosc-0.0.7.tar.gz | 32.6 kB | Without provenance | Details for bosc-0.0.7.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bosc-0.0.7-py3-none-any.whl | Python 3 | none | any | Details for bosc-0.0.7-py3-none-any.whl |
Total release size: 49.1 kB
Release files / bosc-0.0.7.tar.gz
| Download URL | bosc-0.0.7.tar.gz |
|---|---|
| Size | 32.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c224fdf2bf6322cd36c7b4f56fdcee20d8f181269a9d5f21d8a48937123998a9
|
|
BLAKE2b-256 checksum How to use checksums |
b334fe9a483d31b59807cf9674bc36627ce304e156e046e31a46fd2ceedc7412
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.25.1
|
Release files / bosc-0.0.7-py3-none-any.whl
| Download URL | bosc-0.0.7-py3-none-any.whl |
|---|---|
| Size | 16.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
28a9b625ce6edc4f3fcabf90742a5fa3a2dec0cf1e233953f20014a248f1e655
|
|
BLAKE2b-256 checksum How to use checksums |
e324990ccfcbf79d9bdd5284df6c1d4c44f64dafb050860c0a150ef966bbc2d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.25.1
|
Security for bosc 0.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.