[](https://pepy.tech/project/kendama)
# kendama
国税庁が提供するインボイス制度適格請求書発行事業者公表システムWeb-APIを使用するためのクライアントAPI(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 0.1.3
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
Requests is available on PyPI:
```sh
pip install kendama
```
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/uichi/kendama-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/uichi/kendama-python.git`)
Then import the package:
```python
import kendama
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import kendama
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import kendama
from kendama.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://kensyo.invoice-kohyo.nta.go.jp
# See configuration.py for a list of all supported configuration parameters.
configuration = kendama.Configuration(
host = "https://kensyo.invoice-kohyo.nta.go.jp"
)
# Enter a context with an instance of the API client
with kendama.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kendama.V1Api(api_client)
id = 'id_example' # str |
var_from = 'Tue Oct 01 09:00:00 JST 2024' # date |
to = 'Tue Oct 01 09:00:00 JST 2024' # date |
type = '21' # str | (default to '21')
division = '1' # str | (optional) (default to '1')
divide = '1' # str | (optional) (default to '1')
try:
# 取得期間を指定して情報を取得
api_response = api_instance.get_announcement_by_diff(id, var_from, to, type, division=division, divide=divide)
print("The response of V1Api->get_announcement_by_diff:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling V1Api->get_announcement_by_diff: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://kensyo.invoice-kohyo.nta.go.jp*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*V1Api* | [**get_announcement_by_diff**](docs/V1Api.md#get_announcement_by_diff) | **GET** /1/diff | 取得期間を指定して情報を取得
*V1Api* | [**get_announcement_by_number**](docs/V1Api.md#get_announcement_by_number) | **GET** /1/num | 登録番号を指定して情報を取得
*V1Api* | [**get_announcement_by_valid**](docs/V1Api.md#get_announcement_by_valid) | **GET** /1/valid | 登録番号と日付を指定して情報を取得
## Documentation For Models
- [Announcement](docs/Announcement.md)
- [ResponseBody](docs/ResponseBody.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author
- [uichi](https://github.com/uichi)
Raw data
{
"_id": null,
"home_page": "https://github.com/uichi/kendama-python",
"name": "kendama",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,\u56fd\u7a0e\u5e81API",
"author": "uichi",
"author_email": "37263474+uichi@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/64/55/d9b600054ea5f051a10f3e4f3e195cf5734b84b8ee6b197df10b53fb08b6/kendama-0.1.3.tar.gz",
"platform": null,
"description": "[](https://pepy.tech/project/kendama)\n\n# kendama\n\u56fd\u7a0e\u5e81\u304c\u63d0\u4f9b\u3059\u308b\u30a4\u30f3\u30dc\u30a4\u30b9\u5236\u5ea6\u9069\u683c\u8acb\u6c42\u66f8\u767a\u884c\u4e8b\u696d\u8005\u516c\u8868\u30b7\u30b9\u30c6\u30e0Web-API\u3092\u4f7f\u7528\u3059\u308b\u305f\u3081\u306e\u30af\u30e9\u30a4\u30a2\u30f3\u30c8API(https://www.invoice-kohyo.nta.go.jp/web-api/index.html)\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 0.1.3\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nRequests is available on PyPI:\n\n```sh\npip install kendama\n```\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/uichi/kendama-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/uichi/kendama-python.git`)\n\nThen import the package:\n```python\nimport kendama\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport kendama\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport kendama\nfrom kendama.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://kensyo.invoice-kohyo.nta.go.jp\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = kendama.Configuration(\n host = \"https://kensyo.invoice-kohyo.nta.go.jp\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith kendama.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = kendama.V1Api(api_client)\n id = 'id_example' # str | \n var_from = 'Tue Oct 01 09:00:00 JST 2024' # date | \n to = 'Tue Oct 01 09:00:00 JST 2024' # date | \n type = '21' # str | (default to '21')\n division = '1' # str | (optional) (default to '1')\n divide = '1' # str | (optional) (default to '1')\n\n try:\n # \u53d6\u5f97\u671f\u9593\u3092\u6307\u5b9a\u3057\u3066\u60c5\u5831\u3092\u53d6\u5f97\n api_response = api_instance.get_announcement_by_diff(id, var_from, to, type, division=division, divide=divide)\n print(\"The response of V1Api->get_announcement_by_diff:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling V1Api->get_announcement_by_diff: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://kensyo.invoice-kohyo.nta.go.jp*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*V1Api* | [**get_announcement_by_diff**](docs/V1Api.md#get_announcement_by_diff) | **GET** /1/diff | \u53d6\u5f97\u671f\u9593\u3092\u6307\u5b9a\u3057\u3066\u60c5\u5831\u3092\u53d6\u5f97\n*V1Api* | [**get_announcement_by_number**](docs/V1Api.md#get_announcement_by_number) | **GET** /1/num | \u767b\u9332\u756a\u53f7\u3092\u6307\u5b9a\u3057\u3066\u60c5\u5831\u3092\u53d6\u5f97\n*V1Api* | [**get_announcement_by_valid**](docs/V1Api.md#get_announcement_by_valid) | **GET** /1/valid | \u767b\u9332\u756a\u53f7\u3068\u65e5\u4ed8\u3092\u6307\u5b9a\u3057\u3066\u60c5\u5831\u3092\u53d6\u5f97\n\n\n## Documentation For Models\n\n - [Announcement](docs/Announcement.md)\n - [ResponseBody](docs/ResponseBody.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n- [uichi](https://github.com/uichi)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\u56fd\u7a0e\u5e81API",
"version": "0.1.3",
"project_urls": {
"Documentation": "https://github.com/uichi/kendama-python/blob/main/README.md",
"Homepage": "https://github.com/uichi/kendama-python",
"Source": "https://github.com/uichi/kendama-python"
},
"split_keywords": [
"openapi",
"openapi-generator",
"\u56fd\u7a0e\u5e81api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d6c1ad68cb812c92f457bfeadd68a4a74e99a4532ea0d05e0b10bc382416148",
"md5": "357dbb27cfd75fa3859a6299ac2f8c55",
"sha256": "de1f9300167efe9a72f34f2b2f98c69e0539495480af185a2a45bdc4fe90a07a"
},
"downloads": -1,
"filename": "kendama-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "357dbb27cfd75fa3859a6299ac2f8c55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 53199,
"upload_time": "2023-10-16T12:34:03",
"upload_time_iso_8601": "2023-10-16T12:34:03.950232Z",
"url": "https://files.pythonhosted.org/packages/9d/6c/1ad68cb812c92f457bfeadd68a4a74e99a4532ea0d05e0b10bc382416148/kendama-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6455d9b600054ea5f051a10f3e4f3e195cf5734b84b8ee6b197df10b53fb08b6",
"md5": "f2dc8e65d7b6054db6f378e71fda377c",
"sha256": "29e1d0074b6293a97bff0feb6cf836a5305b57a06763846d3f1a2df11318aba3"
},
"downloads": -1,
"filename": "kendama-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "f2dc8e65d7b6054db6f378e71fda377c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43516,
"upload_time": "2023-10-16T12:34:05",
"upload_time_iso_8601": "2023-10-16T12:34:05.786095Z",
"url": "https://files.pythonhosted.org/packages/64/55/d9b600054ea5f051a10f3e4f3e195cf5734b84b8ee6b197df10b53fb08b6/kendama-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-16 12:34:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uichi",
"github_project": "kendama-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "kendama"
}
JSON
