Skip to content

docs: broken import in PyFilesystem usage guide (rspace_client.inv.fs does not exist) #57

Description

@tilorspace

Summary

The PyFilesystem section of docs/usage-guide.md gives an import that does not work. It tells users to do:

from rspace_client.inv import fs

rspace_inv_fs = fs.InventoryAttachmentFilesystem(os.getenv("RSPACE_URL"), os.getenv("RSPACE_API_KEY"))

But there is no rspace_client/inv/fs.py module. The class lives in rspace_client/inv/attachment_fs.py, so from rspace_client.inv import fs raises ImportError.

Location

docs/usage-guide.md, "Using the rspace_client library as PyFilesystem implementation" section (around lines 48-52).

Expected

The example should import from the real module, e.g.:

from rspace_client.inv.attachment_fs import InventoryAttachmentFilesystem

rspace_inv_fs = InventoryAttachmentFilesystem(os.getenv("RSPACE_URL"), os.getenv("RSPACE_API_KEY"))

(The Gallery example just above it is correct because rspace_client/eln/fs.py does exist.)

Notes

Discovered while investigating a unified PyFilesystem across Gallery/ELN/Inventory (branch investigate/unified-pyfilesystem). If that work adds a proper rspace_client/inv/fs.py entry point, an alternative fix is to make the documented import valid rather than changing the docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Fields

    No fields configured for Bug.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions