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

Uploaded Source

Built Distribution

scmrepo-2.0.3-py3-none-any.whl (70.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-2.0.3.tar.gz
  • Upload date:
  • Size: 84.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for scmrepo-2.0.3.tar.gz
Algorithm Hash digest
SHA256 981fa5af7f73cb97490b0ceb56d9b4166cfd318f77ad5b9cf590687aea6ec1cb
MD5 5e8de084be44f28657840e7387f779d2
BLAKE2b-256 dd3671d5606b3e1cd8b84b21b0d3d031be2344922ed157e298338137050240a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 70.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for scmrepo-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 39485c59269259b1571aee84eeac947d51d06e29160e66de2d74e69625de78d9
MD5 78dff8bca8d419799f773d8663741010
BLAKE2b-256 66c639cbbe48fb3aba922accd3bf30c1c18be6a9b88a38e0fae669e92832fc32

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