Skip to content
This repository has been archived by the owner on Jan 22, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rly0nheart authored Oct 30, 2021
1 parent a5f2c60 commit e07534d
Showing 1 changed file with 29 additions and 17 deletions.
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
# CHANGELOG
**Improvements**:
* can now get information on an individual company, including company officer's information
* added flag <code>-n/--company-number</code> ;used for specifying which company to get information on
* added flag <code>-j/--jurisdiction-code</code> ;used for specifying which jurisdiction code to check (recommended: should be used with <code>-n/--company-number</code>)
* bug fixes

# Unofficial Open Corporates CLI

![occli](https://user-images.githubusercontent.com/74001397/137996387-d7f23e1b-395e-499e-8d4d-250d25cca115.jpg)
Expand All @@ -23,52 +16,71 @@ This is an unofficial open corporates command line client.*
# Installation
**Clone From Github**:
```
$ git clone https://github.com/rlyonheart/occli.git
git clone https://github.com/rlyonheart/occli.git
cd occli
```

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


**Install From PyPI**:
```
$ pip install occli
pip install occli
```

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


# Usage
**Github Clone**:
```
$ python occli -c COMPANY-NAME
python occli -c COMPANYNAME
```

**Viewing API version information**:
```
$ python occli --versions
python occli --versions
```

**Alternatively**:
```
chmod +x occli
```

```
occli -c COMPANYNAME
```

```
occli --versions
```


**Getting information on an individual company**:
```
$ python occli -n COMPANY-NUMBER -j JURISDICTION-CODE
occli -n COMPANYNUMBER -j JURISDICTIONCODE
```


**PyPI Package**:
```
$ occli -c COMPANY-NAME
occli -c COMPANYNAME
```

**Viewing version information**
```
$ occli --versions
occli --versions
```

**Getting information on an individual company**:
```
$ occli -n COMPANY-NUMBER -j JURISDICTION-CODE
occli -n COMPANYNUMBER -j JURISDICTIONCODE
```

# Optional Arguments
Expand Down

0 comments on commit e07534d

Please sign in to comment.