File-system specification
Project description
filesystem_spec
A specification for pythonic filesystems.
Install
pip install fsspec
or
conda install -c conda-forge fsspec
Purpose
To produce a template or specification for a file-system interface, that specific implementations should follow,
so that applications making use of them can rely on a common behaviour and not have to worry about the specific
internal implementation decisions with any given backend. Many such implementations are included in this package,
or in sister projects such as s3fs and gcsfs.
In addition, if this is well-designed, then additional functionality, such as a key-value store or FUSE mounting of the file-system implementation may be available for all implementations "for free".
Documentation
Please refer to RTD
Develop
fsspec uses tox and
tox-conda to manage dev and test
environments. First, install conda with tox and tox-conda in a base environment
(eg. conda install -c conda-forge tox tox-conda). Calls to tox can then be
used to configure a development environment and run tests.
First, setup a development conda environment via tox -e {env} where env is one of {py38,py39,py310}.
This will install fsspec dependencies, test & dev tools, and install fsspec in develop
mode. You may activate the dev environment under .tox/{env} via conda activate .tox/{env}.
Testing
Tests can be run in the dev environment, if activated, via pytest fsspec.
Alternatively, the full fsspec test suite can also be run via tox, which will
also build the appropriate environment (see above), with the environment specified
by the TOXENV environment variable.
The full fsspec suite requires a system-level docker, docker-compose, and fuse installation.
Code Formatting
fsspec uses Black to ensure
a consistent code format throughout the project.
Run black fsspec from the root of the filesystem_spec repository to
auto-format your code. Additionally, many editors have plugins that will apply
black as you edit files. black is included in the tox environments.
Optionally, you may wish to setup pre-commit hooks to
automatically run black when you make a git commit.
Run pre-commit install --install-hooks from the root of the
filesystem_spec repository to setup pre-commit hooks. black will now be run
before you commit, reformatting any changed files. You can format without
committing via pre-commit run or skip these checks with git commit --no-verify.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fsspec-2022.10.0.tar.gz.
File metadata
- Download URL: fsspec-2022.10.0.tar.gz
- Upload date:
- Size: 138.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cb6092474e90487a51de768170f3afa50ca8982c26150a59072b16433879ff1d |
|
| MD5 | 76a7c77d1c7476230a3354dc07964a8f |
|
| BLAKE2b-256 | da2bf0e48d57236b3485fb27e31a9419a4a74d3306ad0afe4763c0f53bac3f21 |
File details
Details for the file fsspec-2022.10.0-py3-none-any.whl.
File metadata
- Download URL: fsspec-2022.10.0-py3-none-any.whl
- Upload date:
- Size: 138.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6b7c6ab3b476cdf17efcfeccde7fca28ef5a48f73a71010aaceec5fc15bf9ebf |
|
| MD5 | edfa114f83fc82c6c58eed21b1ebb94c |
|
| BLAKE2b-256 | 4c3d86112db0fc482c4b11031516340e2d9978aa837ee104b4bebaaad0fae465 |
