Changelog¶
[0.3.0] - 2025-01-16¶
New Features ¶
- Streaming uploads.
obstore.put
now supports iterable input, andobstore.put_async
now supports async iterable input. This means you can pass the output ofobstore.get_async
directly intoobstore.put_async
. by @kylebarron in developmentseed/obstore!54 - Allow passing config options directly as keyword arguments. Previously, you had to pass all options as a
dict
into theconfig
parameter. Now you can pass the elements directly to the store constructor. by @kylebarron in developmentseed/obstore!144 - Readable file-like objects. Open a readable file-like object with
obstore.open
andobstore.open_async
. by @kylebarron in developmentseed/obstore!33 - Fsspec integration by @martindurant in developmentseed/obstore!63
- Prefix store by @kylebarron in developmentseed/obstore!117
- Python 3.13 wheels by @kylebarron in developmentseed/obstore!95
- Support python timedelta objects as duration config values by @kylebarron in developmentseed/obstore!146
- Add class constructors for store builders. Each store now has an
__init__
method, for easier construction. by @kylebarron in developmentseed/obstore!141
Breaking changes ¶
-
get_range
,get_range_async
,get_ranges
, andget_ranges_async
now use start/end instead of offset/length. This is for consistency with therange
option ofobstore.get
. by @kylebarron in developmentseed/obstore!71 -
Return
Bytes
fromGetResult.bytes()
by @kylebarron in developmentseed/obstore!134
Bug fixes ¶
- boto3 region name can be None by @kylebarron in developmentseed/obstore!59
- add missing py.typed file by @gruebel in developmentseed/obstore!115
Documentation ¶
- FastAPI/Starlette example by @kylebarron in developmentseed/obstore!145
- Add conda installation doc to README by @kylebarron in developmentseed/obstore!78
- Document suggested lifecycle rules for aborted multipart uploads by @kylebarron in developmentseed/obstore!139
- Add type hint and documentation for requester pays by @kylebarron in developmentseed/obstore!131
- Add note that S3Store can be constructed without boto3 by @kylebarron in developmentseed/obstore!108
- HTTP Store usage example by @kylebarron in developmentseed/obstore!142
What's Changed¶
- Improved docs for from_url by @kylebarron in developmentseed/obstore!138
- Implement read_all for async iterable by @kylebarron in developmentseed/obstore!140
New Contributors¶
- @willemarcel made their first contribution in developmentseed/obstore!64
- @martindurant made their first contribution in developmentseed/obstore!63
- @norlandrhagen made their first contribution in developmentseed/obstore!107
- @gruebel made their first contribution in developmentseed/obstore!115
Full Changelog: github.com/developmentseed/obstore/compare/py-v0.2.0...py-v0.3.0
[0.2.0] - 2024-10-25¶
What's Changed¶
- Streaming list results.
list
now returns an async or sync generator. by @kylebarron in developmentseed/obstore!35 - Optionally return list result as arrow. The
return_arrow
keyword argument returns chunks fromlist
as Arrow RecordBatches, which is faster than materializing Python dicts/lists. by @kylebarron in developmentseed/obstore!38 - Return buffer protocol object from
get_range
andget_ranges
. Enables zero-copy data exchange from Rust into Python. by @kylebarron in developmentseed/obstore!39 - Add put options. Enables custom tags and attributes, as well as "put if not exists". by @kylebarron in developmentseed/obstore!50
- Rename to obstore by @kylebarron in developmentseed/obstore!45
- Add custom exceptions. by @kylebarron in developmentseed/obstore!48
Full Changelog: github.com/developmentseed/obstore/compare/py-v0.1.0...py-v0.2.0
[0.1.0] - 2024-10-21¶
- Initial release.