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

Uploaded Source

Built Distribution

scmrepo-1.3.0-py3-none-any.whl (57.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-1.3.0.tar.gz
  • Upload date:
  • Size: 73.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for scmrepo-1.3.0.tar.gz
Algorithm Hash digest
SHA256 cbba7d5d4ecedb77f6feaa3740853a11802010558465831a2e8960c9fa6aa190
MD5 812af6f8cba74a87a8aa54475bf88a7f
BLAKE2b-256 387a9cb74e927411e274c30a6043357df517ce23466ac86cbaaf774eb2c91735

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 57.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for scmrepo-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 454d223a238f1f4aef5649849101539fb1a3cce2d96b0002caec0569c47af4a4
MD5 94eeaec6d8a090909d5c536e437b0903
BLAKE2b-256 44345a920507b2d257aa29cb4c2a58bf21481ae7ffddf5a642ee6662d0ca089b

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