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

Uploaded Source

Built Distribution

scmrepo-0.1.7-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-0.1.7.tar.gz
  • Upload date:
  • Size: 63.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for scmrepo-0.1.7.tar.gz
Algorithm Hash digest
SHA256 f58d6ebf192ae67ed3ae21ffb54757087335e58de5c55c3a725531c899f50e92
MD5 150e36fee5e1125a343c2e38fbb10261
BLAKE2b-256 6ad21d5828013a34b868b1ca6c61e735171920efbc6889855196e5b7123caacb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 48.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for scmrepo-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 335b0955e0bffc13ba61c7b9519d42c26dc0658744c19062108a105407ee83c0
MD5 a47c0ab265be99c34e132db33e3f41ed
BLAKE2b-256 d201834caa50fff5b068a4288b44da74a8a179713102144b1bd2aa1accdc8ed1

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