11# object-store-python
22
3- <p align =" center " >
4- <a href =" https://github.com/roeap/object-store-python/actions/workflows/ci.yaml " ><img alt =" CI " src =" https://github.com/roeap/object-store-python/actions/workflows/ci.yaml/badge.svg " />
5- <a href =" https://github.com/psf/black " ><img alt =" code style: black " src =" https://img.shields.io/badge/code%20style-black-000000.svg " />
6- </p >
7-
8- Recently, the excellent [ ` object_store ` ] ( https://crates.io/crates/object_store ) crate has been
9- [ donated] ( https://www.influxdata.com/blog/rust-object-store-donation/ ) to the Apache Software Foundation
10- And powers many popular projects like [ datafusion] ( https://github.com/apache/arrow-datafusion ) ,
11- [ InfluxDB IOX] ( https://github.com/influxdata/influxdb_iox ) , [ delta-rs] ( https://github.com/delta-io/delta-rs ) , and more.
12- THe ` object-store-python ` package provides python bindings as well some convenience and pythonic adjustments
13- around the native APIs.
3+ [ ![ CI] [ ci-img ]] [ ci-link ]
4+ [ ![ code style: black] [ black-img ]] [ black-link ]
5+ [ ![ PyPI - Downloads] [ pypi-img ]] [ pypi-link ]
6+
7+ Python bindings and integrations for the excellent [ ` object_store ` ] [ object-store ] crate.
8+ The main idea is to provide a common interface to various storage backends including the
9+ objects stores from most major cloud providers. The APIs are very focussed and taylored
10+ towards modern cloud native applications by hiding away many features (and complexities)
11+ encountered in full fledges file systems.
12+
13+ Among the included backend are:
14+
15+ - Amazon S3 and S3 compliant APIs
16+ - Google Cloud Storage Buckets
17+ - Azure Blob Gen1 and Gen2 accounts (including ADLS Gen2)
18+ - local storage
19+ - in-memory store
1420
1521## Installation
1622
@@ -28,20 +34,8 @@ pip install object-store-python
2834
2935## Usage
3036
31- The main idea behind the ` ObjectStore ` API is to provide a common interface to various
32- storage backends including the objects stores from most major cloud providers. The APIs
33- are very focussed and taylored towards modern cloud native applications by hiding away
34- many features (and complexities) encountered in full fledges file systems.
35-
36- Among the included backend are:
37-
38- - Amazon S3 and S3 compliant APIs
39- - Google Cloud Storage Buckets
40- - Azure Blob Gen1 and Gen2 accounts (including ADLS Gen2)
41- - local storage
42- - in-memory store
43-
44- Additionally, an integration is provided to seamlessly work with the (py)arrow ecosystem.
37+ The main [ ` ObjectStore ` ] ( #object-store-python ) API mirrors the native [ ` object_store ` ] [ object-store ]
38+ implementation, with some slight adjustments for ease of use in python programs.
4539
4640### ` ObjectStore ` api
4741
@@ -119,3 +113,11 @@ To run the rust as well as python tests:
119113``` sh
120114just test
121115```
116+
117+ [ object-store ] : https://crates.io/crates/object_store
118+ [ pypi-img ] : https://img.shields.io/pypi/dm/object-store-python
119+ [ pypi-link ] : https://pypi.org/project/object-store-python/
120+ [ ci-img ] : https://github.com/roeap/object-store-python/actions/workflows/ci.yaml/badge.svg
121+ [ ci-link ] : https://github.com/roeap/object-store-python/actions/workflows/ci.yaml
122+ [ black-img ] : https://img.shields.io/badge/code%20style-black-000000.svg
123+ [ black-link ] : https://github.com/psf/black
0 commit comments