casfs 0.1.1

Content-Addressable filesystem over Pyfilesystem2.

CASFS

CASFS is a content-addressable filestore library, built on pyfilesystem2. CASFS was inspired by hashfs.

This page covers the details of how to

• Use the casfs library in your project, both in and out of an isolated Docker environment
• Develop against casfs, run its tests and contribute code

Installation and Usage

We'll add more here once we're staged on Github and can get proper links to generated docs.

This is a research project, not an official Google product. Expect bugs and sharp edges. Please help by trying out CASFS, reporting bugs, and letting us know what you think!

Developing in CASFS

So you want to add some code to CASFS. Excellent!

We use pre-commit to manage a series of git pre-commit hooks for the project; for example, each time you commit code, the hooks will make sure that your python is formatted properly. If your code isn't, the hook will format it, so when you try to commit the second time you'll get past the hook.

All hooks are defined in .pre-commit-config.yaml. To install these hooks, install pre-commit if you don't yet have it. I prefer using pipx so that pre-commit stays globally available.

pipx install pre-commit

Then install the hooks with this command:

pre-commit install

Now they'll run on every commit. If you want to run them manually, you can run either of these commands:

pre-commit run --all-files

# or this, if you've previously run `make build`:
make lint

Publishing CASFS

• First, run make build to get your virtual environment set up.
• Make sure that you're on the master branch!
• add a new tag, with git tag 0.2.3 or the equivalent
• run make release to push the latest code and tags to all relevant repositories.

Citing CASFS

To cite this repository:

@software{casfs2020github,
  author = {Sam Ritchie},
  title = {{CASFS}: Content-addressable filesystem abstraction for Python.},
  url = {http://github.com/google/casfs},
  version = {0.1.0},
  year = {2020},
}

In the above bibtex entry, names are in alphabetical order, the version number is intended to be that of the latest tag on github, and the year corresponds to the project's open-source release.

License

Copyright 2020 Google LLC.

Licensed under the Apache License, Version 2.0.