Skip to main content

scmrepo

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

Uploaded Source

Built Distribution

scmrepo-3.3.0-py3-none-any.whl (72.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-3.3.0.tar.gz
  • Upload date:
  • Size: 86.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for scmrepo-3.3.0.tar.gz
Algorithm Hash digest
SHA256 36e64f5324764e5784627a9a8d24a95575c5031f69f9c5889e162b50b7dc839d
MD5 97fee30d7d1ea4048e0c52f470a39c74
BLAKE2b-256 630dc9fd8b36823eb2b4625e9bed4fcf7411a491a199d35d61cbd6fbb9eb76ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 72.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for scmrepo-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8424bda848866255f7e465884efae972e6da9a14dc959237dade71e942b94b22
MD5 e601dbc4bb19a0f0cf8e4ebb9fd656ec
BLAKE2b-256 8edac94adc43f7cc4515560672889140d178a7422a8415005936624e94159d25

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