Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rolzwy7 committed Apr 20, 2019
1 parent 4f23e19 commit abda93a
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# RegonAPI

> Python 3 API Client for Polish [REGON database](https://api.stat.gov.pl/Home/RegonApi)
Expand All @@ -6,17 +7,18 @@
![GitHub](https://img.shields.io/github/license/rolzwy7/RegonAPI.svg?color=black&style=flat-square)

---

![example_001.gif](https://rolzwy7.github.io/cdn/projects/RegonAPI/example_001.gif)
<p align="center">
<img src="https://rolzwy7.github.io/cdn/projects/RegonAPI/example_001.gif" alt="RegonAPI example"/>
</p>

## Table of Contents

- [Usage example](#usage-example)
<!-- - [Installation](#installation)
- [Installation](#installation)
- [Features](#features)
- [Tests](#dependencies)
- [Documentation](#documentation)
- [FAQ](#faq) -->
- [Tests](#tests)
<!-- - [Documentation](#documentation) -->
<!-- - [FAQ](#faq) -->

---

Expand All @@ -40,7 +42,7 @@ print("Data status:", api.get_data_status())

---

<!-- ## Installation
## Installation

### Pip

Expand All @@ -50,10 +52,25 @@ python -m pip install RegonAPI

## Features

API enpoints can be accessed with these methods


|Operation|Method|
|:-------| :-------|
|Zaloguj| authenticate|
|DaneSzukaj| searchData|
|DanePobierzPelnyRaport| dataDownloadFullReport|
|GetValue ('KomunikatKod')| get_last_code|
|GetValue ('StanDanych')| get_data_status|
|GetValue ('StatusUslugi')| get_service_status|


REGON API documentation is available at: [https://api.stat.gov.pl/Home/RegonApi](https://api.stat.gov.pl/Home/RegonApi)

## Tests

```
python -m pytest -v RegonAPI/test
```

## FAQ -->
<!-- ## FAQ -->

0 comments on commit abda93a

Please sign in to comment.