Metadata-Version: 1.1
Name: gitfs2
Version: 0.0.1
Summary: Python file system 2 over GitPython
Home-page: https://github.com/moremoban/gitfs2
Author: C.W.
Author-email: wangc_2011@hotmail.com
License: MIT
Download-URL: https://github.com/moremoban/gitfs2/archive/0.0.1.tar.gz
Description: ================================================================================
        gitfs2
        ================================================================================
        
        .. image:: https://api.travis-ci.org/moremoban/gitfs2.svg
           :target: http://travis-ci.org/moremoban/gitfs2
        
        .. image:: https://codecov.io/github/moremoban/gitfs2/coverage.png
           :target: https://codecov.io/github/moremoban/gitfs2
        
        
        .. image:: https://dev.azure.com/moremoban/gitfs2/_apis/build/status/moremoban.gitfs2?branchName=master
           :target: https://dev.azure.com/moremoban/gitfs2/_build/latest?definitionId=2&branchName=master
        
        
        It helps perform `file operations <https://docs.pyfilesystem.org/en/latest/guide.html>`_ over a git repository.
        It clones the git repository and returns python file system 2's `OSFS <https://docs.pyfilesystem.org/en/latest/reference/osfs.html>`_ instance.
        
        The idea originates from `moban <https://github.com/moremoban/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
        --------------------------------------------------------------------------------
        
        .. code-block:: python
        
            >>> import fs
            >>> git_fs = fs.open_fs("git://github.com/moremobans/pypi-mobans.git!/templates")
            >>> git_fs.readtext("_version.py.jj2")
            '__version__ = "0.0.1"\n__author__ = "C.W."\n'
        
        
        Get from a different branch
        --------------------------------------------------------------------------------
        
        .. code-block:: python
        
            >>> 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.1"\n__author__ = "C.W."\n'
        
        
        Checkout submodules recursively
        --------------------------------------------------------------------------------
        
        .. code-block:: python
        
            >>> 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 help
        commit and push the changes for you.
        
        Plus, the intention is never to write to a repository.
        
        
        
        Installation
        ================================================================================
        
        
        You can install gitfs2 via pip:
        
        .. code-block:: bash
        
            $ pip install gitfs2
        
        
        or clone it and install it:
        
        .. code-block:: bash
        
            $ git clone https://github.com/moremoban/gitfs2.git
            $ cd gitfs2
            $ python setup.py install
        
        Change log
        ================================================================================
        
        0.0.1 - None
        --------------------------------------------------------------------------------
        
        first release
        
        
Keywords: python
Platform: UNKNOWN
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
