| Name | osmanthus JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | |
| Summary | An algorithmic chess engine, written in Python. |
| upload_time | 2023-10-17 22:23:42 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | GPL-3.0-or-later |
| keywords |
chess
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/i13e/osmanthus/actions/workflows/main.yml)
[](https://results.pre-commit.ci/latest/github/i13e/osmanthus/master)
# Osmanthus
Osmanthus is a sophisticated chess engine that employs advanced algorithms to provide a challenging
and enjoyable playing experience. It offers a range of features, including self play, puzzle
solving, and an intuitive command-line interface.
## Installation
Osmanthus can be easily installed using pip:
```sh
pip install osmanthus
```
## Usage
To start the CLI interface, enter the following command:
```sh
osmanthus-cli
```
Moves can be input in Standard Algebraic Notation (SAN) or Universal Chess Interface notation. We
recommend using SAN. If you are new to this notation, we have provided a short guide on our [wiki
page](https://github.com/i13e/osmanthus/wiki/san).
If you are new to playing chess, we suggest checking out [this
video](https://www.youtube.com/watch?v=OCSbzArwB10) to learn the fundamentals.
## Contributing
Contributions to Osmanthus are highly appreciated! For suggestions, we recommend looking at any open
issues, particularly those tagged as "Good First Issue" if you are a first-time contributor. We are
also opening new issues related to planned features and bugs that need to be fixed.
When contributing, we ask that you follow the coding style laid out in [Google's Python Style
Guide](https://google.github.io/styleguide/pyguide.html).
Thank you for your interest in Osmanthus, and we look forward to your contributions!
<!-- 谢谢，李桂花。我愛你 -->
Raw data
{
"_id": null,
"home_page": "",
"name": "osmanthus",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "chess",
"author": "",
"author_email": "Ian Breckenridge <i13e@i13e.org>",
"download_url": "https://files.pythonhosted.org/packages/e8/8b/63726f66c396cb5272efb9a78a91f7d01a1976bbe76633637e2dc46a6646/osmanthus-0.1.2.tar.gz",
"platform": null,
"description": "[](https://github.com/i13e/osmanthus/actions/workflows/main.yml)\n[](https://results.pre-commit.ci/latest/github/i13e/osmanthus/master)\n\n\n\n# Osmanthus\n\nOsmanthus is a sophisticated chess engine that employs advanced algorithms to provide a challenging\nand enjoyable playing experience. It offers a range of features, including self play, puzzle\nsolving, and an intuitive command-line interface.\n\n## Installation\n\nOsmanthus can be easily installed using pip:\n\n```sh\npip install osmanthus\n```\n\n## Usage\n\nTo start the CLI interface, enter the following command:\n\n```sh\nosmanthus-cli\n```\n\nMoves can be input in Standard Algebraic Notation (SAN) or Universal Chess Interface notation. We\nrecommend using SAN. If you are new to this notation, we have provided a short guide on our [wiki\npage](https://github.com/i13e/osmanthus/wiki/san).\n\nIf you are new to playing chess, we suggest checking out [this\nvideo](https://www.youtube.com/watch?v=OCSbzArwB10) to learn the fundamentals.\n\n## Contributing\n\nContributions to Osmanthus are highly appreciated! For suggestions, we recommend looking at any open\nissues, particularly those tagged as \"Good First Issue\" if you are a first-time contributor. We are\nalso opening new issues related to planned features and bugs that need to be fixed.\n\nWhen contributing, we ask that you follow the coding style laid out in [Google's Python Style\nGuide](https://google.github.io/styleguide/pyguide.html).\n\nThank you for your interest in Osmanthus, and we look forward to your contributions!\n\n<!-- \u8c22\u8c22\uff0c\u674e\u6842\u82b1\u3002\u6211\u611b\u4f60 -->\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An algorithmic chess engine, written in Python.",
"version": "0.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/i13e/osmanthus/issues",
"Documentation": "https://github.com/i13e/osmanthus/wiki",
"Repository": "https://github.com/i13e/osmanthus"
},
"split_keywords": [
"chess"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0997fcb2b2251a7725782ccbc0b58d7a9459afaa5cca0b87c7ab25205a241c73",
"md5": "a6f95e9a3373636fd4b0540946d367ce",
"sha256": "c17534f3ae98e1fec29cc3c2f464f0662843a765dbded377a21b7e8bab2bab09"
},
"downloads": -1,
"filename": "osmanthus-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6f95e9a3373636fd4b0540946d367ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 1099864,
"upload_time": "2023-10-17T22:23:41",
"upload_time_iso_8601": "2023-10-17T22:23:41.372809Z",
"url": "https://files.pythonhosted.org/packages/09/97/fcb2b2251a7725782ccbc0b58d7a9459afaa5cca0b87c7ab25205a241c73/osmanthus-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e88b63726f66c396cb5272efb9a78a91f7d01a1976bbe76633637e2dc46a6646",
"md5": "8f3f9ed7ccd95415f74ce6f2c02237ed",
"sha256": "6ca92587514a2f51f8b47abf02b73f7ac84bbd3110fbf21bc022415f6b3fd72a"
},
"downloads": -1,
"filename": "osmanthus-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "8f3f9ed7ccd95415f74ce6f2c02237ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1101436,
"upload_time": "2023-10-17T22:23:42",
"upload_time_iso_8601": "2023-10-17T22:23:42.991463Z",
"url": "https://files.pythonhosted.org/packages/e8/8b/63726f66c396cb5272efb9a78a91f7d01a1976bbe76633637e2dc46a6646/osmanthus-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-17 22:23:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "i13e",
"github_project": "osmanthus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "osmanthus"
}
