Skip to main content

SCM wrapper and fsspec filesystem for Git for use in DVC

Project description

PyPI Status Python Version License

Tests Codecov pre-commit Black

SCM wrapper and fsspec filesystem for Git for use in DVC.

Features

  • Works with multiple backends: pygit2, dulwich and gitpython.

  • Provides fsspec filesystem over Git: GitFileSystem.

See fsspec docs for full list of available fs methods.

Requirements

Installation

You can install scmrepo via pip from PyPI:

$ pip install scmrepo

Usage

Git File System

scmrepo provides fsspec based gitfs that provides fs-like API for your git repositories without having to git checkout them first. For example:

from scmrepo.fs import GitFileSystem

fs = GitFileSystem("path/to/my/repo", rev="mybranch")

for root, dnames, fnames in fs.walk("path/in/repo"):
    for dname in dnames:
        print(fs.path.join(root, dname))

    for fname in fnames:
        print(fs.path.join(root, fname))

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the Apache 2.0 license, scmrepo is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scmrepo-0.1.14.tar.gz (63.5 kB view details)

Uploaded Source

Built Distribution

scmrepo-0.1.14-py3-none-any.whl (49.2 kB view details)

Uploaded Python 3

File details

Details for the file scmrepo-0.1.14.tar.gz.

File metadata

  • Download URL: scmrepo-0.1.14.tar.gz
  • Upload date:
  • Size: 63.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for scmrepo-0.1.14.tar.gz
Algorithm Hash digest
SHA256 4f5aef05d807409c3717f37705e9045f12e53326d57eb2b8a3eec0b32d65ce98
MD5 cff24b762d8f2cd2b241b192e0766439
BLAKE2b-256 d972993d9cbc5ff3c26dd2bb1c979d69fa7a9f0c9f4c65936ab593c524d54864

See more details on using hashes here.

Provenance

File details

Details for the file scmrepo-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: scmrepo-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 49.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for scmrepo-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 2588298ed571237e36190530b48fbab8830a09d80a5f9f3c90fdd37cad89e0e9
MD5 95ac961655dbe9aea9071279ba321732
BLAKE2b-256 d9d068ff91c49604d988f37a42be34af9bdeb3f33630feec085fa7bd66239421

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page