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.13.tar.gz (63.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-0.1.13.tar.gz
  • Upload date:
  • Size: 63.4 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.13.tar.gz
Algorithm Hash digest
SHA256 4aeceb48377fdbd45e2a9a1dc30db16d30d998255b8fc2f4469a79ffed101d72
MD5 a5e2dafb7045c37b969b3231b23f376f
BLAKE2b-256 0d4b22630ec35eaddeb0a00b0faddc6f95bcdc3836b2a56332115a040dbd4e1b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-0.1.13-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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 37b4f5bb8c9cc3c50703131c5383efaf9b846538f262f62af29c2c8d9e9f6bdc
MD5 b425edeb1c0e839150ca8e10fca20b2c
BLAKE2b-256 330641f991ae3412bdfbdb8388b8c521b301e00c6704cf99091f92d19062e326

See more details on using hashes here.

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