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

Uploaded Source

Built Distribution

scmrepo-3.2.0-py3-none-any.whl (72.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scmrepo-3.2.0.tar.gz
Algorithm Hash digest
SHA256 84a20ee3b0c555c8756977141065a92927ecc67afd5c782ef11a502d0848f422
MD5 4ce9a2aa339cd5ade5baa0a08f889a68
BLAKE2b-256 f9b6aec2972544ad2e90ea741f6d29490de83b2e4ee4cfd8d27c849aac6432b9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for scmrepo-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b031278dbb14a5c100b9f381ba9abd4d1653d3e2d34dd0347efd23073d8a5204
MD5 c102f450865654f273840cfceb8f4502
BLAKE2b-256 ca77b90a680ade3f3172525500c36b28970e76e63da3328cf4fa1a9a8a71bc6e

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