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

Uploaded Source

Built Distribution

scmrepo-1.3.1-py3-none-any.whl (57.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-1.3.1.tar.gz
  • Upload date:
  • Size: 73.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for scmrepo-1.3.1.tar.gz
Algorithm Hash digest
SHA256 11fe5fb4815d2aa1c2d1bcc63898228f0eb7106a18529243dd9fad34b57ef0dc
MD5 99c9867675b54dcb41a0fca100bf5ddd
BLAKE2b-256 7868d2465a0a15dbd3e3343bedec38962f8b1d719796acce22539d0edb5be98f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 57.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for scmrepo-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 143af909ac42eb05dc7f214bb4347b32dd7d8a37e2224f6b452606b7d781ecd1
MD5 369a5b1dd57c720e46828ddbcdbe853c
BLAKE2b-256 026b2085b04d693734c6ae3611475ea3f49855e2a1c3ddeacbc2c76b40a5311b

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