Metadata-Version: 2.1
Name: easygit
Version: 1.0.4
Summary: Library to learn git
Home-page: UNKNOWN
Author: Sharan Babu
Author-email: sharanbabu2001@gmail.com
License: UNKNOWN
Keywords: python,chatbot,git,interactive terminal
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE

# easygit [![Upload Python Package](https://github.com/Sharan-Babu/easygit/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Sharan-Babu/easygit/actions/workflows/python-publish.yml) [![Python application](https://github.com/Sharan-Babu/easygit/actions/workflows/python-app.yml/badge.svg)](https://github.com/Sharan-Babu/easygit/actions/workflows/python-app.yml) ![PyPI - Downloads](https://img.shields.io/pypi/dw/easygit) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)

Generate git syntax, commands by interacting with the terminal in English.

[**Documentation**](https://github.com/Sharan-Babu/easygit/wiki/Documentation) | [**Contribution Guidelines**](https://github.com/Sharan-Babu/easygit/wiki/Contribution) | [**Releases**](https://github.com/Sharan-Babu/easygit/releases) | [**Wiki**](https://github.com/Sharan-Babu/easygit/wiki)

![crop1](https://user-images.githubusercontent.com/65604809/125606457-12ef44ca-2110-481b-b797-00528e863635.jpeg)


This repo is also meant to be a reference for learning how to create libraries in Python and use various features that Github provides like Github Actions, Projects and Releases. Well detailed notes on the same can be found [here](https://github.com/Sharan-Babu/easygit/wiki).

## Installation
~~~
pip install easygit
~~~

## How to use:
~~~python
from easygit import Easygit
git = Easygit()
git.interactive()
~~~

## Upgrade Package to latest version
~~~
pip install --upgrade easygit
~~~

## Cloning repo 
_Note_: Will likely contain changes not yet released in PyPI library.
~~~
pip install colorama wit
git clone https://github.com/Sharan-Babu/easygit.git
~~~

## Versioning [![PyPI version](https://badge.fury.io/py/easygit.svg)](https://badge.fury.io/py/easygit)
You can download specific versions of the library [here](https://github.com/Sharan-Babu/easygit/releases).

## Overview

`easygit` library comes with the Easygit class which has the following methods:
### 1) `query()` 
Used to retrieve explanation/_git_ syntax for given sentence.

Example Usage:
~~~python
git = Easygit()
git.query("How to clone a repository using git?")
~~~

Output:<br>
~~~
git clone <repository_web_url>
~~~

### 2) `interactive()` 
Used to start interactive mode in terminal.
~~~python
git = Easygit()
git.interactive()
~~~

Output:<br>
~~~
Interactive mode:

Enter your query: 
~~~
![carbon](https://user-images.githubusercontent.com/65604809/125470522-8da84acf-0e7e-450e-927a-2484ffde3732.png)

## License
MIT License

## Awesome Contributors

Sharan Babu: [<img src="https://github.com/sainiteshb/sainiteshb/blob/master/assets/Linkedin.svg" alt="Linkedin Logo" width="20" height="25">](https://www.linkedin.com/in/sharan-babu-39a757197/) <br>
Rajesh Silvoj: [<img src="https://github.com/sainiteshb/sainiteshb/blob/master/assets/Linkedin.svg" alt="Linkedin Logo" width="20" height="25">](https://www.linkedin.com/in/silvoj-rajesh-kumar-ba655b1a7/) <br>


[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)


