Metadata-Version: 2.1
Name: occli
Version: 0.3.5
Summary: Open Corporates CLI
Home-page: https://github.com/rly0nheart/occli
Author: Richard Mwewa
Author-email: richardmwewa@duck.com
License: GNU General Public License v3 (GPLv3)
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE

![logo](https://user-images.githubusercontent.com/74001397/176042400-fe48a5ca-d6fd-4aa6-b6ea-0b9fabee9262.png)

![Python Version](https://img.shields.io/badge/python-3.x-blue?style=flat&logo=python)
![GitHub](https://img.shields.io/github/license/rly0nheart/occli?style=flat)
![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=downloads)](https://pepy.tech/project/occli)
![GitHub repo size](https://img.shields.io/github/repo-size/rly0nheart/occli?style=flat&logo=github)

Occli is a command line tool that queries the [Open Corporates Database](https://opencorporates.com) and returns data on corporations under the copyleft Open Database License.

# Installation
## Clone from Github
```
git clone https://github.com/rly0nheart/occli.git
```

```
cd occli
```

```
python setup.py sdist bdist_wheel
```

```
pip install dist/occli-[version.tag]-py3-none.whl
```

## Install from PyPI
```
pip install occli
```

# Usage
```
occli 'query'
```
## Updating
```
pip install --upgrade occli
```

# Optional Arguments
| Option         | Argument | Usage|
| ------------- |:----------------------:|:---------:|
| ``-o/--output``      |   path/to/file |  write output to a specified file  |
| ``-c/--count``  |    |  number of results to return (1-30) (default: 30) |
| ``-v/--verbose``  |    |  enable verbosity |

# Note
> Occli is in no way affiliated with Open Corporates. This project only uses their public API, therefore, user privacy policies and terms of service will be applied as provided by [Open Corporates](https://opencorporates.com/legal/user_privacy_policy) itself.

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