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

Uploaded Source

Built Distribution

scmrepo-0.2.0-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scmrepo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d210a057e456377ad5d0317bff631c4f6eda6979b98bb086dadbb5ab340c3825
MD5 150b88823b9cb4aed2ea72577bac36cc
BLAKE2b-256 45ecfa36b8f9f2f1744c35a70345a91fca8cd2f3f81f3ab8620123df6b236d5f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 54.1 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7076890ad5dd137e9fdec5ca9879cd1787bd9739f90f954247d9f6707674fd85
MD5 f356742168c6577a23a223a13da766ef
BLAKE2b-256 826737d8992e22629ee0061ead68b3a8ae60911c7550d1d0d7f72211943388b1

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