Metadata-Version: 2.1
Name: atudomain-git
Version: 2.0.0
Summary: Convenience library for working with Git on Linux. Requires git >= 2.20
Home-page: https://github.com/atudomain/atudomain-python-git
Author: Adrian Tuzimek
Author-email: tuziomek@gmail.com
License: UNKNOWN
Description: # Python GIT Library
        
        - License: 3-Clause BSD
        - Pythons: Python 3.5+
        - Platforms: Linux
        - Git: 2.20+
        ##
        This library is Just What You Need when working with git repositories from Python.
        It is simple, but extremely flexible.
        
        Provides Commit objects and easy branch inspection.
        
        Git.run() method returns subprocess.run() results, but takes git command as string argument.
        
        ## Table of Contents
        - [Installation](#installation)
        - [Quickstart](#quickstart)
            - [Getting Branches](#getting-branches)
            - [Getting Commits](#getting-commits)
            - [Getting Commit details](#getting-commit-details)
            - [Executing commands in repository](#executing-commands-in-repository)
        - [API Documentation](#api-documentation)
        
        ## Installation
        
        Install using pip:
        ```bash
        python3 -m pip install atudomain-git --user 
        ```
        
        Otherwise, just can just append downloaded repository path to PYTHONPATH.
        
        ## Quickstart
        
        Import Git class:
        ```python
        from atudomain.git.Git import Git
        ```
        
        Create Git object:
        ```python
        git = Git('/home/user/example-repo')
        ```
        
        ### Getting branches
        Get list of remote origin branches:
        ```python
        branches = git.get_branches(include='^remotes/origin')
        ```
        
        Get list of local branches:
        ```python
        branches = git.get_branches(exclude='^remotes/')
        ```
        
        ### Getting Commits
        Get list of Commits for the current branch:
        ```python
        commits = git.get_commits()
        ```
        
        Get list with last Commit for the current branch:
        ```python
        commits = git.get_commits('HEAD^..HEAD')
        ```
        
        ### Getting Commit details
        Get committer date from Commit:
        ```python
        committer_date = commits[0].committer_date
        ```
        
        Get commit id from Commit:
        ```python
        commit_id = commits[0].commit_id
        ```
        
        Check if Commit is a merge:
        ```python
        is_merge = commits[0].is_merge
        ```
        
        ### Executing commands in repository
        Get 'git status -s' output as a string:
        ```python
        result = git.run('status -s').stdout
        ```
        
        ## API Documentation
        https://atudomain-python-git.readthedocs.io/en/latest/
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Requires-Python: >=3.5
Description-Content-Type: text/markdown
