Metadata-Version: 2.1
Name: gitsearch-cli
Version: 0.2
Summary: Search git from the command line
Home-page: UNKNOWN
Author: Owen Rumney
Author-email: owen@owenrumney.co.uk
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests (==2.19.1)
Requires-Dist: tabulate (==0.8.2)

# Git Search
Simple command line to search github.

## Introduction
`git-search` is a simple command line tool that allows you to search for users and repositories in [GitHub](http://www.github.com).

## Installation
To install git search you can use `pip` with the following command;

```shell
pip3 install gitsearch-cli
```

## Usage
By default the search will be scoped to look in repositories, however you can change the scope to look specifically for users.

### Searching for Users
```shell
git-search --scope users owen rumney

or

git-search --scope users owenrumney
```

This will yield the following results;

| username   | url                           |
|:-----------|:------------------------------|
| owenrumney | https://github.com/owenrumney |

### Searching for repositories
When searching for repositories you can create a general search by keyword or focus the search by including the language and/or user.

```shell
git-search -l scala -u apache spark
```
This will give the following result;

| name          | owner   | url                                     |
|:--------------|:--------|:----------------------------------------|
| fluo-muchos   | apache  | https://github.com/apache/fluo-muchos   |
| predictionio  | apache  | https://github.com/apache/predictionio  |
| spark         | apache  | https://github.com/apache/spark         |
| spark-website | apache  | https://github.com/apache/spark-website |

If you want to only return results where the keyword is in the name, you can use the `--nameonly` flag

```shell
git-search -l scala -u apache spark --nameonly
```
This will give the following result;

| name          | owner   | url                                     |
|:--------------|:--------|:----------------------------------------|
| spark         | apache  | https://github.com/apache/spark         |
| spark-website | apache  | https://github.com/apache/spark-website |

## TODO
- [ ] Add date based options for search criteria
- [ ] Refactor the code to be more pythonic

