Skip to main content

filesystem_spec

PyPI version Anaconda-Server Badge Build Docs

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 {py36,py37,py38,py39}. This will install fspec 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.

Metadata

Release files for fsspec 2021.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fsspec 2021.11.0
File Size Uploaded Provenance Actions
fsspec-2021.11.0.tar.gz 134.4 kB Without provenance Details for fsspec-2021.11.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fsspec 2021.11.0
File Interpreter ABI Platform Actions
fsspec-2021.11.0-py3-none-any.whl Python 3 none any Details for fsspec-2021.11.0-py3-none-any.whl

Total release size: 266.8 kB

Release files / fsspec-2021.11.0.tar.gz

Download URL fsspec-2021.11.0.tar.gz
Size 134.4 kB
Tags Source
SHA-256 checksum
How to use checksums
cbb7bafd59aa33684a92e843877f4adc0109fb0722b1a26e7d08f5a6e2500904
BLAKE2b-256 checksum
How to use checksums
f8329531a913d0a01fe6010bde761946bad72419f51be5056cfefa926656cccf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Release files / fsspec-2021.11.0-py3-none-any.whl

Download URL fsspec-2021.11.0-py3-none-any.whl
Size 132.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8843f31c7a7bb1afc4add371948f10701814594d407ee1b0bb4facec8b517efa
BLAKE2b-256 checksum
How to use checksums
edf57b39f9621874c19bcb0f27dda4955ef6cc279045a51fc0ae72c40515e799
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

Security for fsspec 2021.11.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2021.11.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page