fsspec / fsspec/filesystem_spec

GithubFileSystem cannot be conveniently used for local GitHubs

Open
#774 6 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

Implementations.github.GithubFileSystem cannot be used as-is and can not be easily customized for local GitHub instances used in a company. The general github.com url (and general raw content url) is not used as a variable, but as string literal in several places, so to use the code, the only option at the moment is to copy and modifiy it. Would be nice to fix this, so the base GitHub URL could be passed as argument to the constructor for instance.

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 at Implementations.github.GithubFileSystem and locate the hard-coded GitHub and raw-content URLs. Make the base GitHub URL configurable through the constructor, ensuring local GitHub instances use the corresponding URLs instead of fixed github.com values; verify the filesystem works against a local instance.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.