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

Uploaded Source

Built Distribution

scmrepo-0.1.10-py3-none-any.whl (49.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-0.1.10.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.10.tar.gz
Algorithm Hash digest
SHA256 11629300f4f6da1741e685806e87f4f39fa66a0f99f5868e8724fb01779776cc
MD5 76bb9648e13bb3f3b6c5ceab2c2a498b
BLAKE2b-256 00e79be14f6d87f44a8d403f545f169b3d1a3d9dae485706f40be538222f0f03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 49.0 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 51c02846cb9625330ba8be3b53949ab2740591a95477a097f2f2962273cc8d1b
MD5 1018ea977b6d6415156008da1edac145
BLAKE2b-256 bf7c0e419ca886e669f87f05395d25f543cba21167aa805c34084c82519d8012

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