# shindan-cli
[![Release Package](
<https://github.com/eggplants/shindan-cli/actions/workflows/release.yml/badge.svg>
)](
<https://github.com/eggplants/shindan-cli/actions/workflows/release.yml>
) [![PyPI](
<https://img.shields.io/pypi/v/shindan-cli?color=blue>
)](
<https://pypi.org/project/shindan-cli>
) [![PyPI - Python Version](
<https://img.shields.io/pypi/pyversions/shindan-cli>
)](
<https://pypi.org/project/shindan-cli>
)
[![Test](
<https://github.com/eggplants/shindan-cli/actions/workflows/test.yml/badge.svg>
)](
<https://github.com/eggplants/shindan-cli/actions/workflows/test.yml>
) [![Maintainability](
<https://api.codeclimate.com/v1/badges/9134b56a4241e91dfa01/maintainability>
)](
<https://codeclimate.com/github/eggplants/shindan-cli/maintainability>
) [![Test Coverage](
<https://api.codeclimate.com/v1/badges/9134b56a4241e91dfa01/test_coverage>
)](
<https://codeclimate.com/github/eggplants/shindan-cli/test_coverage>
)
ShindanMaker (<https://shindanmaker.com>) CLI
## Install
```bash
pip install shindan-cli
```
## Usage
### CLI
```shellsession
$ shindan -h
usage: shindan [-h] [-w] [-H] [-l] [-V] ID NAME
ShindanMaker (https://shindanmaker.com) CLI
positional arguments:
ID shindan page id
NAME shindan name
optional arguments:
-h, --help show this help message and exit
-w, --wait insert random wait
-H, --hashtag add hashtag `#shindanmaker`
-l, --link add link to last of output
-V, --version show program's version number and exit
$ shindan 1036646 hoge
ねこって、むしだ。
𝙐𝙉𝙄𝙌𝙇𝙊
$ shindan 1036646 huga -l
ねこって、むしだ。
𝙉𝙄𝙎𝙎𝙄𝙉
https://shindanmaker.com/1036646
$ shindan 1036646 huga -l -H
ねこって、むしだ。
𝙁𝙐𝙅𝙄𝙏𝙎𝙐
#shindanmaker
https://shindanmaker.com/1036646
```
### Library
```python
from shindan_cli import shindan
# type: (int, str, optional[bool]) -> ShindanResults
shindan(1036646, 'hoge', wait=False)
```
Returns:
```python
{
'results': ['ねこって、むしだ。', '', '𝙏𝙊𝙆𝙔𝙊 𝙈𝙀𝙏𝙍𝙊'],
'hashtags': ['#shindanmaker'],
'shindan_url': 'https://shindanmaker.com/1036646'
}
```
## License
MIT
---
## Similar Imprementations
- C#
- [misodengaku/ShindanMaker](https://github.com/misodengaku/ShindanMaker)
- Library
- Go
- [kakakaya/goshindan](https://github.com/kakakaya/goshindan)
- Library + CLI
- <https://pkg.go.dev/github.com/kakakaya/goshindan>
- Java
- [shibafu528/shindan4j](https://github.com/shibafu528/shindan4j)
- Library
- <https://jitpack.io/#shibafu528/shindan4j>
- JavaScript
- [asawo/shindan-scraper](https://github.com/asawo/shindan-scraper)
- Library
- [stawberri/shindan](https://github.com/stawberri/shindan)
- Library (Archived)
- <https://www.npmjs.com/package/shindan>
- Perl
- [Likk/WebService-ShindanMaker](https://github.com/Likk/WebService-ShindanMaker)
- Library
- PHP
- [moroya/php-shindanmaker](https://github.com/moroya/php-shindanmaker)
- Library
- <https://packagist.org/packages/moroya/php-shindanmaker>
- Python
- [Le96/auto_shindanmaker](https://github.com/Le96/auto_shindanmaker)
- Bot Server
- [tanitanin/shindan-python](https://github.com/tanitanin/shindan-python)
- CLI (Script)
- Ruby
- [osak/shindanmaker](https://github.com/osak/shindanmaker)
- [Mikutter](https://github.com/mikutter/mikutter) Plugin
- [gouf/shindan](https://github.com/gouf/shindan)
- Library
- [ikaruga777/shindan-cli](https://github.com/ikaruga777/shindan-cli)
- CLI
- [yasuhito/shindan](https://github.com/yasuhito/shindan)
- CLI
- <https://rubygems.org/gems/shindan>
- TypeScript
- [dqn/shindanmaker-js](https://github.com/dqn/shindanmaker-js)
- Library
Raw data
{
"_id": null,
"home_page": "https://github.com/eggplants/shindan-cli",
"name": "shindan_cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "shindanmaker, cli",
"author": "eggplants",
"author_email": "w10776e8w@yahoo.co.jp",
"download_url": "https://files.pythonhosted.org/packages/ba/eb/d2c9a9f6b250664d1f49c3fabf47069a034c81806a2cc6b56e9ac685cbf5/shindan_cli-2.1.0.tar.gz",
"platform": null,
"description": "# shindan-cli\n\n[![Release Package](\n <https://github.com/eggplants/shindan-cli/actions/workflows/release.yml/badge.svg>\n)](\n <https://github.com/eggplants/shindan-cli/actions/workflows/release.yml>\n) [![PyPI](\n <https://img.shields.io/pypi/v/shindan-cli?color=blue>\n)](\n <https://pypi.org/project/shindan-cli>\n) [![PyPI - Python Version](\n <https://img.shields.io/pypi/pyversions/shindan-cli>\n )](\n <https://pypi.org/project/shindan-cli>\n)\n\n[![Test](\n <https://github.com/eggplants/shindan-cli/actions/workflows/test.yml/badge.svg>\n)](\n <https://github.com/eggplants/shindan-cli/actions/workflows/test.yml>\n) [![Maintainability](\n <https://api.codeclimate.com/v1/badges/9134b56a4241e91dfa01/maintainability>\n)](\n <https://codeclimate.com/github/eggplants/shindan-cli/maintainability>\n) [![Test Coverage](\n <https://api.codeclimate.com/v1/badges/9134b56a4241e91dfa01/test_coverage>\n)](\n <https://codeclimate.com/github/eggplants/shindan-cli/test_coverage>\n)\n\nShindanMaker (<https://shindanmaker.com>) CLI\n\n## Install\n\n```bash\npip install shindan-cli\n```\n\n## Usage\n\n### CLI\n\n```shellsession\n$ shindan -h\nusage: shindan [-h] [-w] [-H] [-l] [-V] ID NAME\n\nShindanMaker (https://shindanmaker.com) CLI\n\npositional arguments:\n ID shindan page id\n NAME shindan name\n\noptional arguments:\n -h, --help show this help message and exit\n -w, --wait insert random wait\n -H, --hashtag add hashtag `#shindanmaker`\n -l, --link add link to last of output\n -V, --version show program's version number and exit\n\n$ shindan 1036646 hoge\n\u306d\u3053\u3063\u3066\u3001\u3080\u3057\u3060\u3002\n\n\ud835\ude50\ud835\ude49\ud835\ude44\ud835\ude4c\ud835\ude47\ud835\ude4a\n\n$ shindan 1036646 huga -l\n\u306d\u3053\u3063\u3066\u3001\u3080\u3057\u3060\u3002\n\n\ud835\ude49\ud835\ude44\ud835\ude4e\ud835\ude4e\ud835\ude44\ud835\ude49\nhttps://shindanmaker.com/1036646\n\n$ shindan 1036646 huga -l -H\n\u306d\u3053\u3063\u3066\u3001\u3080\u3057\u3060\u3002\n\n\ud835\ude41\ud835\ude50\ud835\ude45\ud835\ude44\ud835\ude4f\ud835\ude4e\ud835\ude50\n#shindanmaker\nhttps://shindanmaker.com/1036646\n```\n\n### Library\n\n```python\nfrom shindan_cli import shindan\n# type: (int, str, optional[bool]) -> ShindanResults\nshindan(1036646, 'hoge', wait=False)\n```\n\nReturns:\n\n```python\n{\n 'results': ['\u306d\u3053\u3063\u3066\u3001\u3080\u3057\u3060\u3002', '', '\ud835\ude4f\ud835\ude4a\ud835\ude46\ud835\ude54\ud835\ude4a \ud835\ude48\ud835\ude40\ud835\ude4f\ud835\ude4d\ud835\ude4a'],\n 'hashtags': ['#shindanmaker'],\n 'shindan_url': 'https://shindanmaker.com/1036646'\n}\n```\n\n## License\n\nMIT\n\n---\n\n## Similar Imprementations\n\n- C#\n - [misodengaku/ShindanMaker](https://github.com/misodengaku/ShindanMaker)\n - Library\n- Go\n - [kakakaya/goshindan](https://github.com/kakakaya/goshindan)\n - Library + CLI\n - <https://pkg.go.dev/github.com/kakakaya/goshindan>\n- Java\n - [shibafu528/shindan4j](https://github.com/shibafu528/shindan4j)\n - Library\n - <https://jitpack.io/#shibafu528/shindan4j>\n- JavaScript\n - [asawo/shindan-scraper](https://github.com/asawo/shindan-scraper)\n - Library\n - [stawberri/shindan](https://github.com/stawberri/shindan)\n - Library (Archived)\n - <https://www.npmjs.com/package/shindan>\n- Perl\n - [Likk/WebService-ShindanMaker](https://github.com/Likk/WebService-ShindanMaker)\n - Library\n- PHP\n - [moroya/php-shindanmaker](https://github.com/moroya/php-shindanmaker)\n - Library\n - <https://packagist.org/packages/moroya/php-shindanmaker>\n- Python\n - [Le96/auto_shindanmaker](https://github.com/Le96/auto_shindanmaker)\n - Bot Server\n - [tanitanin/shindan-python](https://github.com/tanitanin/shindan-python)\n - CLI (Script)\n- Ruby\n - [osak/shindanmaker](https://github.com/osak/shindanmaker)\n - [Mikutter](https://github.com/mikutter/mikutter) Plugin\n - [gouf/shindan](https://github.com/gouf/shindan)\n - Library\n - [ikaruga777/shindan-cli](https://github.com/ikaruga777/shindan-cli)\n - CLI\n - [yasuhito/shindan](https://github.com/yasuhito/shindan)\n - CLI\n - <https://rubygems.org/gems/shindan>\n- TypeScript\n - [dqn/shindanmaker-js](https://github.com/dqn/shindanmaker-js)\n - Library\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ShindanMaker (https://shindanmaker.com) CLI",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/eggplants/shindan-cli",
"Repository": "https://github.com/eggplants/shindan-cli"
},
"split_keywords": [
"shindanmaker",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "989202ef1dfa2687b2df03b4d51b239c6595b93ccf61621f6353b68038647557",
"md5": "87524ea27fa14890bbe421d6bf188feb",
"sha256": "a9a6d05f407b4e651fc8330a154b2840bd94b5e7d070793269a0d644b616de80"
},
"downloads": -1,
"filename": "shindan_cli-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87524ea27fa14890bbe421d6bf188feb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 10140,
"upload_time": "2024-11-11T06:27:12",
"upload_time_iso_8601": "2024-11-11T06:27:12.934751Z",
"url": "https://files.pythonhosted.org/packages/98/92/02ef1dfa2687b2df03b4d51b239c6595b93ccf61621f6353b68038647557/shindan_cli-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "baebd2c9a9f6b250664d1f49c3fabf47069a034c81806a2cc6b56e9ac685cbf5",
"md5": "d79a83bdae1d0c7d44ccc08bb747a076",
"sha256": "ecfbc5d566792e007c9e6d2021ae3f3167af2dc39391c961637ba7a1855e07b6"
},
"downloads": -1,
"filename": "shindan_cli-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d79a83bdae1d0c7d44ccc08bb747a076",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 9148,
"upload_time": "2024-11-11T06:27:14",
"upload_time_iso_8601": "2024-11-11T06:27:14.477964Z",
"url": "https://files.pythonhosted.org/packages/ba/eb/d2c9a9f6b250664d1f49c3fabf47069a034c81806a2cc6b56e9ac685cbf5/shindan_cli-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-11 06:27:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eggplants",
"github_project": "shindan-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shindan_cli"
}