-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# RegonAPI | ||
|
||
> Python 3 API Client for Polish [REGON database](https://api.stat.gov.pl/Home/RegonApi) | ||
|
||
![GitHub](https://img.shields.io/github/license/rolzwy7/RegonAPI.svg?color=black&style=flat-square) | ||
|
||
--- | ||
|
||
## Table of Contents | ||
|
||
- [Usage example](#usage-example) | ||
<!-- - [Installation](#installation) | ||
- [Features](#features) | ||
- [Tests](#dependencies) | ||
- [Documentation](#documentation) | ||
- [FAQ](#faq) --> | ||
|
||
--- | ||
|
||
## Usage example | ||
|
||
```python | ||
from RegonAPI import RegonAPI | ||
|
||
# Regon API - WSDL file | ||
WSDL = "https://wyszukiwarkaregontest.stat.gov.pl/wsBIR/wsdl/UslugaBIRzewnPubl.xsd" | ||
# Regon API - Service URL | ||
SERVICE_URL = "https://wyszukiwarkaregontest.stat.gov.pl/wsBIR/UslugaBIRzewnPubl.svc" | ||
# Regon API - test key | ||
API_KEY = "abcde12345abcde12345" | ||
|
||
api = RegonAPI(wsdl=WSDL, service_url=SERVICE_URL) | ||
api.authenticate(key=API_KEY) | ||
|
||
print("Data status:", api.get_data_status()) | ||
``` | ||
|
||
--- | ||
|
||
<!-- ## Installation | ||
### Pip | ||
``` | ||
python -m pip install RegonAPI | ||
``` | ||
## Features | ||
## Tests | ||
``` | ||
python -m pytest -v RegonAPI/test | ||
``` | ||
## FAQ --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
import setuptools | ||
|
||
with open("pypi-readme.md", "r") as fh: | ||
long_description = fh.read() | ||
|
||
setuptools.setup( | ||
name="RegonAPI", | ||
version="1.0.0", | ||
author="Bartosz Nowakowski", | ||
author_email="rolzwy7@gmail.com", | ||
description="Python 3 API Client for Polish REGON database", | ||
long_description=long_description, | ||
long_description_content_type="text/markdown", | ||
url="https://github.com/rolzwy7/RegonAPI", | ||
packages=setuptools.find_packages(), | ||
classifiers=[ | ||
"Programming Language :: Python :: 3", | ||
"License :: OSI Approved :: MIT License", | ||
"Operating System :: OS Independent", | ||
"Topic :: Database :: Front-Ends", | ||
"Environment :: Console", | ||
], | ||
install_requires=[ | ||
"zeep", | ||
"beautifulsoup4", | ||
] | ||
) |