Skip to content

Commit

Permalink
boto router docs (#2830)
Browse files Browse the repository at this point in the history
  • Loading branch information
johnnyaug authored Dec 26, 2021
1 parent c849b34 commit da7a47d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/integrations/boto.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ redirect_from: ../using/boto.html
# Using lakeFS with Boto (Python)
{: .no_toc }

To use Boto with lakeFS alongside S3, check out [Boto S3 Router](https://github.com/treeverse/boto-s3-router){:target="_blank"}. It will route
requests to either S3 or lakeFS according to the provided bucket name.
{: .note }

lakeFS exposes an S3-compatible API, so you can use Boto to interact with your objects on lakeFS.
{% include toc.html %}

## Creating a Boto client
Expand All @@ -24,6 +29,7 @@ s3 = boto3.client('s3',
aws_secret_access_key='wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY')
```

The client is now configured to operate on your lakeFS installation.

## Usage Examples

Expand All @@ -35,6 +41,8 @@ with open('/local/path/to/file_0', 'rb') as f:
s3.put_object(Body=f, Bucket='example-repo', Key='main/example-file.parquet')
```

You can now commit this change using the lakeFS UI or CLI.

### List Objects

List branch objects starting with a prefix:
Expand Down

0 comments on commit da7a47d

Please sign in to comment.