Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

gitsnapshot

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gitsnapshot

Python module to simplify loading of snapshot of git repository

  • 0.1.2
  • PyPI
  • Socket score

Maintainers
1

gitsnapshot

Build Status PyPI version

A simple library to load snapshots of git repository.

Usage

To load git repository call load_repo as follows:

from gitsnapshot import load_repo

load_repo('~/target/directory', 'git@github.com/test/repo')

This code creates folder ~/target/directory if this folder doesn't exists, and then clone shallow copy of repository git@github.com/test/repo. By default this function loads current master branch.

To load another branch (i.e. develop) pass branch name in branch parameter:

from gitsnapshot import load_repo

load_repo('~/target/directory', 'git@github.com/test/repo', branch='develop')

Also you can load snapshot by tag:

from gitsnapshot import load_repo

load_repo('~/target/directory', 'git@github.com/test/repo', tag='v0.1.2')

Or by commit hash:

from gitsnapshot import load_repo

load_repo('~/target/directory', 'git@github.com/test/repo', commit='abcdef')

Errors

load_repo function return optional string with error description. If load_repo returned None then no errors was happened.

Reusing of directory

If you try to load repository snapshot into existing directory with another snapshot of the same repository, load_repo will return error. To avoid this behavior pass use_existing=True as argument.

from gitsnapshot import load_repo

load_repo('~/target/directory', 'git@github.com/test/repo', use_existing=True)

In this case load_repo will load repository index and will checkout to specified branch, tag or commit.

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc