Metadata-Version: 2.1
Name: occli
Version: 0.3.4
Summary: Unofficial Command Line Interface for OpenCorporates
Home-page: https://github.com/rly0nheart/occli
Author: Richard Mwewa
Author-email: richardmwewa@duck.com
License: GNU General Public License v3 (GPLv3)
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE

![occli](https://user-images.githubusercontent.com/74001397/137996387-d7f23e1b-395e-499e-8d4d-250d25cca115.jpg)
![Python Version](https://img.shields.io/badge/python-3.x-blue?style=flat&logo=python)
![OS](https://img.shields.io/badge/OS-GNU%2FLinux-red?style=flat&logo=linux)
![GitHub](https://img.shields.io/github/license/rly0nheart/occli?style=flat&logo=github)
![CodeFactor](https://www.codefactor.io/repository/github/rly0nheart/occli/badge)
![PyPI](https://img.shields.io/pypi/v/occli?style=flat&logo=pypi)
[![Downloads](https://static.pepy.tech/personalized-badge/occli?period=total&units=none&left_color=grey&right_color=yellowgreen&left_text=pypi%20downloads)](https://pepy.tech/project/occli)
![GitHub repo size](https://img.shields.io/github/repo-size/rly0nheart/occli?style=flat&logo=github)

> [OpenCorporates](https://opencorporates.com) is a website that shares data on corporations under the copyleft Open Database License.

# Installation & Usage
**Install From PyPI**:
```
$ pip install occli
```

```
$ occli -q [company-name]
```

**Upgrade to latest version**:
```
$ pip install --upgrade occli
```


**Clone From Github**:
```
$ git clone https://github.com/rly0nheart/occli.git
```

```
$ cd occli
```

```
$ pip install -r requirements.txt
```

```
$ python occli -q [company-name]
```

# Optional Arguments
| Flag         | MetaVar | Usage|
| ------------- |:----------------------:|:---------:|
| <code>-q/--query</code>  |  company-name  | company-name  |
| <code>-d/--dump</code>      |   *path/to/file* |  dump output to a specified file  |
| <code>-v/--verbose</code>  |    |  run occli in verbose mode (recommended) |
| <code>--version</code>  |    |  view program's version number and exit' |
| <code>--licence/--license</code>  |    |  show program's licen(cs)e and exit' |

# LICENSE
![license](https://user-images.githubusercontent.com/74001397/137917929-2f2cdb0c-4d1d-4e4b-9f0d-e01589e027b5.png)

# About author
* [About.me](https://about.me/rly0nheart)

