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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: scmrepo-2.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 17e75b6b8d730d84e0e0479f4b4e15fce7f191c54ee9604164004041cf0f07de
MD5 fad1cb4ad4210ba1c7bde823caf13bb2
BLAKE2b-256 3ea4aa08ce0f092b9b1a4d59540f767a70b9c567ec31484af89ed719765659b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scmrepo-2.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a6227c7b12455d674c370d8c31f4ae2bd6127e329eac33614da4cc0f39917518
MD5 384d40a16ab76687ad140f142abf72f2
BLAKE2b-256 ed9bdd3f6b424eba3cb3ac70c73055a0b934f08e0e32b2cb6116bb7385ac9292

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