Metadata-Version: 2.1
Name: pychfs
Version: 0.0.1
Summary: CHFS Python bindings
Home-page: https://github.com/donkomura/PyCHFS
Author: Kazuki Obata, Sohei Koyama
Author-email: obata@hpcs.cs.tsukuba.ac.jp, skoyama@hpcs.cs.tsukuba.ac.jp
Description-Content-Type: text/markdown
License-File: LICENSE

# PyCHFS

PyCHFS is the Python bindings for CHFS (consistent hashing file system).

# Requirements

* [CHFS](https://github.com/otatebe/chfs)

# Getting Started

## Installation

```
$ pip install pychfs
```

## Create file system

You can create CHFS by `chfsctl` and set `CHFS_SERVER` environmental variable.

```
$ eval `chfsctl start`
$ chlist # show started servers
```

# Developing

## Building locally

```
$ python setup.py build_ext --inplace
```

## VSCode devcontainer

You can use VSCode devcontainer to develop fsspec-chfs.
The setup steps are follows:

1. Install Docker and Remote-Container extension.
2. Press Ctrl+Shift+P in VSCode.
3. select `Remote-Container: Open the folder in the Container`

## Testing

```
$ eval `chfsctl start` # start the server and set CHFS_SERVER
$ tox
```
