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

This version

0.1.3

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

Uploaded Source

Built Distribution

scmrepo-0.1.3-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scmrepo-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9ae20c2dc32a588215bb9b76040129cec68e2ef51b06cda48cdc32df15575998
MD5 c036033dcc64abf0e183ceb34c0543ed
BLAKE2b-256 cb64f883b842dcc8a0c5b9a874b88a083310a4e90830d81d144206f3465901bb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for scmrepo-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5327d8ea37320adf4e38effe4dd272e737c372137e84af57c56eefe36c33feb5
MD5 e78021eb0517423b7e1457a23b38c7b7
BLAKE2b-256 67c14ce2daee7ce0ac06cbe08ede006eb027db80878044226fcbc4ef8ef8c5ef

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