fsspec


Namefsspec JSON
Version 0.8.7 PyPI version JSON
download
home_pagehttp://github.com/intake/filesystem_spec
SummaryFile-system specification
upload_time2021-02-23 17:57:32
maintainerMartin Durant
docs_urlNone
author
requires_python>3.6
licenseBSD
keywords file
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # filesystem_spec

[![PyPI version](https://badge.fury.io/py/fsspec.svg)](https://pypi.python.org/pypi/fsspec/)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/fsspec/badges/version.svg)](https://anaconda.org/conda-forge/fsspec)
![Build](https://github.com/intake/filesystem_spec/workflows/CI/badge.svg)
[![Docs](https://readthedocs.org/projects/filesystem-spec/badge/?version=latest)](https://filesystem-spec.readthedocs.io/en/latest/?badge=latest)

A specification for pythonic filesystems.

## Install

```bash
pip install fsspec
```
or
```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 [tox](https://tox.readthedocs.io/en/latest/) and
[tox-conda](https://github.com/tox-dev/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 dev`. This will
install fspec dependencies, test & dev tools, and install fsspec in develop
mode. Then, activate the dev environment under `.tox/dev` via `conda activate .tox/dev`.

### Testing

Tests can be run directly in the activated dev environment via `pytest fsspec`.

The full fsspec test suite can be run via `tox`, which will setup and execute
tests against multiple dependency versions in isolated environment. Run `tox
-av` to list available test environments, select environments via `tox -e <env>`.

The full fsspec suite requires a system-level docker, docker-compose, and fuse
installation. See `ci/install.sh` for a detailed installation example.

### Code Formatting

fsspec uses [Black](https://black.readthedocs.io/en/stable) to ensure
a consistent code format throughout the project. ``black`` is automatically
installed in the tox dev env, activated via `conda activate .tox/dev`.

Then, 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.

Optionally, you may wish to setup [pre-commit hooks](https://pre-commit.com) to
automatically run `black` when you make a git commit. ``black`` is automatically
installed in the tox dev env, activated via `conda activate .tox/dev`.

Then, 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": "http://github.com/intake/filesystem_spec",
    "name": "fsspec",
    "maintainer": "Martin Durant",
    "docs_url": null,
    "requires_python": ">3.6",
    "maintainer_email": "mdurant@anaconda.com",
    "keywords": "file",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/de/db/67e67696a979fb4a356ec123f34b9ea2b3886c3a4232483e506ab5e78378/fsspec-0.8.7.tar.gz",
    "platform": "",
    "description": "# filesystem_spec\n\n[![PyPI version](https://badge.fury.io/py/fsspec.svg)](https://pypi.python.org/pypi/fsspec/)\n[![Anaconda-Server Badge](https://anaconda.org/conda-forge/fsspec/badges/version.svg)](https://anaconda.org/conda-forge/fsspec)\n![Build](https://github.com/intake/filesystem_spec/workflows/CI/badge.svg)\n[![Docs](https://readthedocs.org/projects/filesystem-spec/badge/?version=latest)](https://filesystem-spec.readthedocs.io/en/latest/?badge=latest)\n\nA specification for pythonic filesystems.\n\n## Install\n\n```bash\npip install fsspec\n```\nor\n```bash\nconda install -c conda-forge fsspec\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 [tox](https://tox.readthedocs.io/en/latest/) and\n[tox-conda](https://github.com/tox-dev/tox-conda) to manage dev and test\nenvironments. First, install conda with tox and tox-conda in a base environment\n(eg. `conda install -c conda-forge tox tox-conda`). Calls to `tox` can then be\nused to configure a development environment and run tests.\n\nFirst, setup a development conda environment via `tox -e dev`. This will\ninstall fspec dependencies, test & dev tools, and install fsspec in develop\nmode. Then, activate the dev environment under `.tox/dev` via `conda activate .tox/dev`.\n\n### Testing\n\nTests can be run directly in the activated dev environment via `pytest fsspec`.\n\nThe full fsspec test suite can be run via `tox`, which will setup and execute\ntests against multiple dependency versions in isolated environment. Run `tox\n-av` to list available test environments, select environments via `tox -e <env>`.\n\nThe full fsspec suite requires a system-level docker, docker-compose, and fuse\ninstallation. See `ci/install.sh` for a detailed installation example.\n\n### Code Formatting\n\nfsspec uses [Black](https://black.readthedocs.io/en/stable) to ensure\na consistent code format throughout the project. ``black`` is automatically\ninstalled in the tox dev env, activated via `conda activate .tox/dev`.\n\nThen, run `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.\n\nOptionally, you may wish to setup [pre-commit hooks](https://pre-commit.com) to\nautomatically run `black` when you make a git commit. ``black`` is automatically\ninstalled in the tox dev env, activated via `conda activate .tox/dev`.\n\nThen, run `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\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "File-system specification",
    "version": "0.8.7",
    "split_keywords": [
        "file"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c32d2166f6b3a0d80b302c4271a3a841",
                "sha256": "65dbf8244a3a3d23342109925f9f588c7551b2b01a5f47e555043b17e2b32d62"
            },
            "downloads": -1,
            "filename": "fsspec-0.8.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c32d2166f6b3a0d80b302c4271a3a841",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.6",
            "size": 103460,
            "upload_time": "2021-02-23T17:57:31",
            "upload_time_iso_8601": "2021-02-23T17:57:31.404483Z",
            "url": "https://files.pythonhosted.org/packages/91/0d/a6bfee0ddf47b254286b9bd574e6f50978c69897647ae15b14230711806e/fsspec-0.8.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f7324747d2b2efff12aa9f36baa5c245",
                "sha256": "4b11557a90ac637089b10afa4c77adf42080c0696f6f2771c41ce92d73c41432"
            },
            "downloads": -1,
            "filename": "fsspec-0.8.7.tar.gz",
            "has_sig": false,
            "md5_digest": "f7324747d2b2efff12aa9f36baa5c245",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.6",
            "size": 104593,
            "upload_time": "2021-02-23T17:57:32",
            "upload_time_iso_8601": "2021-02-23T17:57:32.926079Z",
            "url": "https://files.pythonhosted.org/packages/de/db/67e67696a979fb4a356ec123f34b9ea2b3886c3a4232483e506ab5e78378/fsspec-0.8.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-23 17:57:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "intake",
    "error": "Could not fetch GitHub repository",
    "lcname": "fsspec"
}
        
Elapsed time: 0.24254s