# filesystem_spec
[](https://pypi.python.org/pypi/fsspec/)
[](https://anaconda.org/conda-forge/fsspec)
[](https://filesystem-spec.readthedocs.io/en/latest/?badge=latest)
[](https://pepy.tech/project/fsspec)
A specification for pythonic filesystems.
## Install
```bash
pip install fsspec
```
would install the base fsspec. Various optionally supported features might require specification of custom
extra require, e.g. `pip install fsspec[ssh]` will install dependencies for `ssh` backends support.
Use `pip install fsspec[full]` for installation of all known extra dependencies.
Up-to-date package also provided through conda-forge distribution:
```bash
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](https://filesystem-spec.readthedocs.io/en/latest/?badge=latest)
## Develop
fsspec uses GitHub Actions for CI. Environment files can be found
in the "ci/" directory. Note that the main environment is called "py38",
but it is expected that the version of python installed be adjustable at
CI runtime. For local use, pick a version suitable for you.
### Testing
Tests can be run in the dev environment, if activated, via ``pytest fsspec``.
The full fsspec suite requires a system-level docker, docker-compose, and fuse
installation. If only making changes to one backend implementation, it is
not generally necessary to run all tests locally.
It is expected that contributors ensure that any change to fsspec does not
cause issues or regressions for either other fsspec-related packages such
as gcsfs and s3fs, nor for downstream users of fsspec. The "downstream" CI
run and corresponding environment file run a set of tests from the dask
test suite, and very minimal tests against pandas and zarr from the
test_downstream.py module in this repo.
### Code Formatting
fsspec uses [Black](https://black.readthedocs.io/en/stable) 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](https://pre-commit.com) 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``.
Raw data
{
"_id": null,
"home_page": "https://github.com/fsspec/filesystem_spec",
"name": "fsspec",
"maintainer": "Martin Durant",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "mdurant@anaconda.com",
"keywords": "file",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8b/b8/e3ba21f03c00c27adc9a8cd1cab8adfb37b6024757133924a9a4eab63a83/fsspec-2024.3.1.tar.gz",
"platform": null,
"description": "# filesystem_spec\n\n[](https://pypi.python.org/pypi/fsspec/)\n[](https://anaconda.org/conda-forge/fsspec)\n\n[](https://filesystem-spec.readthedocs.io/en/latest/?badge=latest)\n[](https://pepy.tech/project/fsspec)\n\nA specification for pythonic filesystems.\n\n## Install\n\n```bash\npip install fsspec\n```\n\nwould install the base fsspec. Various optionally supported features might require specification of custom\nextra require, e.g. `pip install fsspec[ssh]` will install dependencies for `ssh` backends support.\nUse `pip install fsspec[full]` for installation of all known extra dependencies.\n\nUp-to-date package also provided through conda-forge distribution:\n\n```bash\nconda install -c conda-forge fsspec\n```\n\n\n## Purpose\n\nTo produce a template or specification for a file-system interface, that specific implementations should follow,\nso that applications making use of them can rely on a common behaviour and not have to worry about the specific\ninternal implementation decisions with any given backend. Many such implementations are included in this package,\nor in sister projects such as `s3fs` and `gcsfs`.\n\nIn addition, if this is well-designed, then additional functionality, such as a key-value store or FUSE\nmounting of the file-system implementation may be available for all implementations \"for free\".\n\n## Documentation\n\nPlease refer to [RTD](https://filesystem-spec.readthedocs.io/en/latest/?badge=latest)\n\n## Develop\n\nfsspec uses GitHub Actions for CI. Environment files can be found\nin the \"ci/\" directory. Note that the main environment is called \"py38\",\nbut it is expected that the version of python installed be adjustable at\nCI runtime. For local use, pick a version suitable for you.\n\n### Testing\n\nTests can be run in the dev environment, if activated, via ``pytest fsspec``.\n\nThe full fsspec suite requires a system-level docker, docker-compose, and fuse\ninstallation. If only making changes to one backend implementation, it is\nnot generally necessary to run all tests locally.\n\nIt is expected that contributors ensure that any change to fsspec does not\ncause issues or regressions for either other fsspec-related packages such\nas gcsfs and s3fs, nor for downstream users of fsspec. The \"downstream\" CI\nrun and corresponding environment file run a set of tests from the dask\ntest suite, and very minimal tests against pandas and zarr from the\ntest_downstream.py module in this repo.\n\n### Code Formatting\n\nfsspec uses [Black](https://black.readthedocs.io/en/stable) to ensure\na consistent code format throughout the project.\nRun ``black fsspec`` from the root of the filesystem_spec repository to\nauto-format your code. Additionally, many editors have plugins that will apply\n``black`` as you edit files. ``black`` is included in the ``tox`` environments.\n\nOptionally, you may wish to setup [pre-commit hooks](https://pre-commit.com) to\nautomatically run ``black`` when you make a git commit.\nRun ``pre-commit install --install-hooks`` from the root of the\nfilesystem_spec repository to setup pre-commit hooks. ``black`` will now be run\nbefore you commit, reformatting any changed files. You can format without\ncommitting via ``pre-commit run`` or skip these checks with ``git commit\n--no-verify``.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "File-system specification",
"version": "2024.3.1",
"project_urls": {
"Changelog": "https://filesystem-spec.readthedocs.io/en/latest/changelog.html",
"Documentation": "https://filesystem-spec.readthedocs.io/en/latest/",
"Homepage": "https://github.com/fsspec/filesystem_spec"
},
"split_keywords": [
"file"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "936d66d48b03460768f523da62a57a7e14e5e95fdf339d79e996ce3cecda2cdb",
"md5": "de0d17ff3523398dec14ce823186d599",
"sha256": "918d18d41bf73f0e2b261824baeb1b124bcf771767e3a26425cd7dec3332f512"
},
"downloads": -1,
"filename": "fsspec-2024.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de0d17ff3523398dec14ce823186d599",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 171991,
"upload_time": "2024-03-18T19:35:11",
"upload_time_iso_8601": "2024-03-18T19:35:11.259910Z",
"url": "https://files.pythonhosted.org/packages/93/6d/66d48b03460768f523da62a57a7e14e5e95fdf339d79e996ce3cecda2cdb/fsspec-2024.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8bb8e3ba21f03c00c27adc9a8cd1cab8adfb37b6024757133924a9a4eab63a83",
"md5": "f5ca6fd1f7661fffc68d067218f940fa",
"sha256": "f39780e282d7d117ffb42bb96992f8a90795e4d0fb0f661a70ca39fe9c43ded9"
},
"downloads": -1,
"filename": "fsspec-2024.3.1.tar.gz",
"has_sig": false,
"md5_digest": "f5ca6fd1f7661fffc68d067218f940fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 170742,
"upload_time": "2024-03-18T19:35:13",
"upload_time_iso_8601": "2024-03-18T19:35:13.995961Z",
"url": "https://files.pythonhosted.org/packages/8b/b8/e3ba21f03c00c27adc9a8cd1cab8adfb37b6024757133924a9a4eab63a83/fsspec-2024.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 19:35:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fsspec",
"github_project": "filesystem_spec",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "fsspec"
}
JSON
