fsspec / fsspec/filesystem_spec

Documentation for using Compress/Decompress?

Open
#1,775 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.4k
Forks
490
Avg merge
2d 3h
Merged PRs (30d)
38

Description

I noticed that fsspec has fsspec.compression but it's not documented anywhere how to use it. Even a simple example would help on how to create a fs using fsspec and write files compressed to it.

The other thing I read is that fsspec doesn't have compression dependencies, if I want to use zstd, which package am I suppose to add for that to work with fsspec ?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation entry points for fsspec.compression and checking existing documentation conventions. Verify the workflow for creating an fsspec filesystem, writing compressed files, and identifying the package needed for zstd; done when concise guidance answers both questions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.