Skip to main content

Python file system 2 over GitPython

Project description

https://api.travis-ci.org/moremoban/gitfs2.svg https://codecov.io/github/moremoban/gitfs2/coverage.png https://badge.fury.io/py/gitfs2.svg https://pepy.tech/badge/gitfs2/month https://dev.azure.com/moremoban/gitfs2/_apis/build/status/moremoban.gitfs2?branchName=master

It helps perform file operations over a git repository. It clones the git repository and returns python file system 2’s OSFS instance.

The idea originates from moban, which uses git repositories as a vehicle to have versioned templates for the creation of a new python package. Surely, it can be implemented in any other ways but moban v0.6.0 mandates python file system 2 interface. Hence this library is written.

Get a file inside a python package

>>> import fs
>>> git_fs = fs.open_fs("git://github.com/moremobans/pypi-mobans.git!/templates")
>>> git_fs.readtext("_version.py.jj2")
'__version__ = "0.0.3"\n__author__ = "C.W."\n'

Get from a different branch

>>> import fs
>>> git_fs = fs.open_fs("git://github.com/moremobans/pypi-mobans.git?branch=master!/templates")
>>> git_fs.read("_version.py.jj2")
'__version__ = "0.0.3"\n__author__ = "C.W."\n'

Checkout submodules recursively

>>> git_fs = fs.open_fs("git://github.com/moremobans/pypi-mobans.git?branch=master&submodule=true!/templates")

Does it write?

Yes locally, it will write as you can do so without using gitfs2. And no, it does not help commit and push the changes for you.

Plus, the intention is never to write to a repository.

License

MIT

Installation

You can install gitfs2 via pip:

$ pip install gitfs2

or clone it and install it:

$ git clone https://github.com/moremoban/gitfs2.git
$ cd gitfs2
$ python setup.py install

Change log

0.0.3 - 11.12.2019

Added

  1. #5: support offline
  2. #7: add license text

0.0.2 - 2.10.2019

Fixed

  1. #4: failed to checkout more than one git repo.

0.0.1 - 19.08.2019

first release

  1. what a feat!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gitfs2, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size gitfs2-0.0.3-py2.py3-none-any.whl (6.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size gitfs2-0.0.3.tar.gz (7.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page