Skip to content

Commit ef1a4b5

Browse files
authored
docs: Add obspec to the user guide (#466)
* Add a page on obspec to the user guide * Update obspec user guide doc
1 parent b04a926 commit ef1a4b5

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/obspec.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Generic storage abstractions with Obspec
2+
3+
Obstore provides an implementation for accessing Amazon S3, Google Cloud Storage, and Azure Storage, but some libraries may want to support other backends, such as HTTP clients or more obscure things like SFTP or HDFS filesystems.
4+
5+
There's a bunch of useful behavior that could exist on top of Obstore: caching, metrics, globbing, bulk operations. While all of those operations are useful, we want to keep the core Obstore library as small as possible, tightly coupled with the underlying Rust `object_store` library.
6+
7+
[Obspec](https://developmentseed.org/obspec/) exists to provide the abstractions for generic programming against object store backends. Obspec is essentially a formalization and generalization of the Obstore API, so if you're already using Obstore, very few changes are needed to use Obspec instead.
8+
9+
Downstream libraries can program against the Obspec API to be fully generic around what underlying backend is used at runtime.
10+
11+
For further information, refer to the [Obspec documentation](https://developmentseed.org/obspec/latest/) and the [Obspec announcement blog post](https://developmentseed.org/obspec/latest/blog/2025/06/25/introducing-obspec-a-python-protocol-for-interfacing-with-object-storage/).

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ nav:
2828
- getting-started.md
2929
- cookbook.md
3030
- authentication.md
31+
- obspec.md
3132
- Integrations:
3233
- integrations/index.md
3334
- fsspec: integrations/fsspec.md

0 commit comments

Comments
 (0)