Metadata-Version: 2.1
Name: littlegit
Version: 0.2.0b6
Summary: This is a little tiny wrapper around Git CLI
Home-page: https://github.com/expobrain/littlegit
Author: Daniele Esposti
Author-email: daniele.esposti@gmail.com
License: MIT
Description: # Littlegit
        
        A very little Python wrapper around Git CLI.
        
        Littlegit doesn't need any external dependency except for the [Git](https://git-scm.com/) binary to be installed in your system.
        
        All the current, past and future commands and options of Git are fully supported.
        
        ## Installation
        
        Install Littlegit with `pip`:
        
        ```
        pip install littlegit
        ```
        
        ## Usage
        
        To use Littlegit is very simple, it follows a very simple rule to map Git's commands to Littlegit's API:
        
        - every Git command is a method
        - every argument is a method's argument
        - every option is a method's keywords
        
        Lets explain this with an example of initialising a local repository, adding a file and commiting:
        
        ```python
        repo = Git("/my/local/repo")
        repo.init()  # git init /my/local/repo
        
        open("myfile", "w").close()
        
        repo.add("myfile")  # git add myfile
        repo.commit(message="this is my first commit")  # git commit --message "this is my first commit"
        repo.remote("add", "origin", "<my_remote_repo>")  # git remote add origin <my_remote_repo>
        repo.push("origin", "master")  # git push origin master
        ```
        
        All the methods return the output if the Git command:
        
        ```python
        output = repo.branch(remote=True)  # git branch --remote
        print(output)
        origin/HEAD -> origin/master
        origin/master
        ```
        
        ## Tests
        
        To run the unit tests install the development dependencies and then run [PyTest](https://pytest.org/):
        
        ```
        pip install -r requirements_dev.txt
        pytest tests.py
        ```
        
Platform: UNKNOWN
Classifier: License :: Public Domain
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: System
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
