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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scmrepo-1.6.0-py3-none-any.whl (71.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scmrepo-1.6.0.tar.gz
Algorithm Hash digest
SHA256 0092c3f99da7db327602fb1f655b9cca9a936ffabee7ab79eb6be23d627af7a2
MD5 907025577f66b2b16014c8d8c2a45977
BLAKE2b-256 7acb7171ed74f65a498e5b3a24781359fc2926b19879ed4ae77cce08e17039c9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for scmrepo-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 389c3ae694309c62268ce193d149a5bd344af28306943fe332a9907b0cb6d0fb
MD5 929b791b459730f50cab2e33567104a7
BLAKE2b-256 b33b2361391ffaa200e858ddac71494ba71b3683d1cb8306f32dd650aeb602b4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page