Metadata-Version: 2.1
Name: exasol-bucketfs
Version: 0.5.0
Summary: BucketFS utilities for the Python programming language
Home-page: https://github.com/exasol/bucketfs-python
License: MIT
Keywords: exasol,bucketfs
Author: Torsten Kilias
Author-email: torsten.kilias@exasol.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: joblib (>=1.0.1)
Requires-Dist: requests (>=2.24.0)
Requires-Dist: typeguard (>=2.11.1)
Project-URL: Repository, https://github.com/exasol/bucketfs-python
Description-Content-Type: text/x-rst

Bucketfs Python
###############

Overview
********

This project provides a python library for accessing the Exasol BucketFS system.
It provides functions to upload and download files to and from the BucketFS.

In a Nutshell
=============

Prerequisites
-------------

- `Python <https://www.python.org/>`_ >= 3.8
- `Poetry <https://python-poetry.org/>`_ >= 1.2

Installation
-------------

Install the package from Github via `pip`::

    pip install -e git+https://github.com/exasol/bucketfs-utils-python.git@{tag name}#egg=exasol-bucketfs-utils-python

Or install the wheel directly via::

    pip install https://github.com/exasol/bucketfs-utils-python/releases/download/{tag name}/exasol_bucketfs_utils_python-{tag name}-py3-none-any.whl

Documentation
-------------

`Documentation for the current main branch <https://exasol.github.io/bucketfs-utils-python/main>`_ is hosted on the Github Pages of this project.
`Here <https://exasol.github.io/bucketfs-utils-python>`_  is a list of documentations for previous releases.

Features
========

* Download or upload files from/to the Exasol BucketFS
* Supported sources and targets for the uploads and downloads:

  * Files on the local Filesystem
  * Python file objects
  * Python Strings
  * Python objects ((De-)Serialization with `Joblib <https://joblib.readthedocs.io/en/latest/persistence.html>`_)

* Loading an artefact from a public Github Release into the BucketFS

