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

Uploaded Source

Built Distribution

scmrepo-3.3.8-py3-none-any.whl (73.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-3.3.8.tar.gz
  • Upload date:
  • Size: 94.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for scmrepo-3.3.8.tar.gz
Algorithm Hash digest
SHA256 e0d71cef4725dbee2cefab0cfff0a3a65d8cc213a53b468d4e3fa61ba2ec66f4
MD5 93e9e91d673d2983de713167b3690723
BLAKE2b-256 d61982a0dac4531c486f079c304397acf48bafae80d92ad05161ac9fa1c787fd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-3.3.8-py3-none-any.whl
  • Upload date:
  • Size: 73.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for scmrepo-3.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 fd841811d17b46579ba96e4a142da33a117d368dc5cdd60047dc772fd427c9b4
MD5 5e6621c56a82775dbad5303e81ebf117
BLAKE2b-256 7244a83109a4a30c1086c0f8a2ac7f67c173aea31d6f99687324dca85fd03e4a

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