| Name | pyNonogram JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | https://github.com/Apsurt/pyNonogram |
| Summary | Nonogram framework for Python |
| upload_time | 2024-01-02 14:24:39 |
| maintainer | |
| docs_url | None |
| author | Tymon Becella |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Tymon Becella Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
nonogram
nonograms
griddlers
picross
pic-a-pix
paintbynumbers
puzzle
puzzles
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numpy
pytest
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyNonogram
Framework for puzzle game *Nonogram*. It was made thinking about projects that aim to solve puzzles. I wanted to create comprehensive library that would take some work of nonogram developers' shoulders.
It is my first package thus, reporting issues and pull request are more than appreciated.
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Usage](#usage)
- [File extension](#file-extension-non)
- [Code example](#code-example)
- [Contributing](#contributing)
- [License](#license)
## Installation
Install with [pip](https://pypi.org/project/pyNonogram/):
```
pip install pyNonogram
```
## Documentation
The documentation is available [here](https://apsurt.github.io/pyNonogram-docs/)
## Usage
### File extension (.non)
Example .non file:
```
author:Apsurt
date:31.12.23
picture:2
difficulty:2
width:5
height:5
rows:1 3 2,2 3 1 1
columns:1 3 2,3 3 1
solution:001000111011011011100010000100
```
Note that there is no space before nor after the colon. Separate row or column hints are separated by space character, whereas hints in the same row or column are separated with coma. For row hints in sequence are from left to right, for columns from top to bottom.
### Code example
```
from pyNonogram import Nonogram
my_nonogram = Nonogram()
my_nonogram.load("house.non")
my_nonogram.grid.fill_row(2, 1)
my_nonogram.print()
```
For more elaborate examples check out [GitHub](https://github.com/Apsurt/pyNonogram/tree/main/examples)
## Contributing
TBA
## License
This project is licensed under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/Apsurt/pyNonogram",
"name": "pyNonogram",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "nonogram,nonograms,griddlers,picross,pic-a-pix,paintbynumbers,puzzle,puzzles",
"author": "Tymon Becella",
"author_email": "Tymon Becella <tymon@becella.eu>",
"download_url": "https://files.pythonhosted.org/packages/83/95/58895d1e213ecb1155d3ce29dd6d1897e111e03ee86b5ab8c4fc89f97fb6/pyNonogram-0.3.0.tar.gz",
"platform": null,
"description": "# pyNonogram\n\nFramework for puzzle game *Nonogram*. It was made thinking about projects that aim to solve puzzles. I wanted to create comprehensive library that would take some work of nonogram developers' shoulders.\n\nIt is my first package thus, reporting issues and pull request are more than appreciated.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [Usage](#usage)\n - [File extension](#file-extension-non)\n - [Code example](#code-example)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nInstall with [pip](https://pypi.org/project/pyNonogram/):\n\n```\npip install pyNonogram\n```\n\n## Documentation\n\nThe documentation is available [here](https://apsurt.github.io/pyNonogram-docs/)\n\n## Usage\n\n### File extension (.non)\n\nExample .non file:\n\n```\nauthor:Apsurt\ndate:31.12.23\npicture:2\ndifficulty:2\nwidth:5\nheight:5\nrows:1 3 2,2 3 1 1\ncolumns:1 3 2,3 3 1\nsolution:001000111011011011100010000100\n```\n\nNote that there is no space before nor after the colon. Separate row or column hints are separated by space character, whereas hints in the same row or column are separated with coma. For row hints in sequence are from left to right, for columns from top to bottom.\n\n### Code example\n\n```\nfrom pyNonogram import Nonogram\n\nmy_nonogram = Nonogram()\nmy_nonogram.load(\"house.non\")\n\nmy_nonogram.grid.fill_row(2, 1)\n\nmy_nonogram.print()\n```\n\nFor more elaborate examples check out [GitHub](https://github.com/Apsurt/pyNonogram/tree/main/examples)\n\n## Contributing\n\nTBA\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Tymon Becella Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Nonogram framework for Python",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/Apsurt/pyNonogram/",
"Issues": "https://github.com/Apsurt/pyNonogram/issues"
},
"split_keywords": [
"nonogram",
"nonograms",
"griddlers",
"picross",
"pic-a-pix",
"paintbynumbers",
"puzzle",
"puzzles"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9096e6a911fb1bd539c9c2df834b7bb76cf5c12a04f45305d5947a079e2c2ec5",
"md5": "4366d33c9e662b7139119d8aef472693",
"sha256": "c4b251d3f01667ac0fc129e0ee5ac55c1a7188975bd83859dbc401404b2467bd"
},
"downloads": -1,
"filename": "pyNonogram-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4366d33c9e662b7139119d8aef472693",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8339,
"upload_time": "2024-01-02T14:24:38",
"upload_time_iso_8601": "2024-01-02T14:24:38.550086Z",
"url": "https://files.pythonhosted.org/packages/90/96/e6a911fb1bd539c9c2df834b7bb76cf5c12a04f45305d5947a079e2c2ec5/pyNonogram-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "839558895d1e213ecb1155d3ce29dd6d1897e111e03ee86b5ab8c4fc89f97fb6",
"md5": "b14dca28ec2528a14aedf9b38ab58f86",
"sha256": "8151a0c5f6a77a2897286ef96e0c2594786df5b086bb105ff1d87ba5d4a35486"
},
"downloads": -1,
"filename": "pyNonogram-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b14dca28ec2528a14aedf9b38ab58f86",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10899,
"upload_time": "2024-01-02T14:24:39",
"upload_time_iso_8601": "2024-01-02T14:24:39.796138Z",
"url": "https://files.pythonhosted.org/packages/83/95/58895d1e213ecb1155d3ce29dd6d1897e111e03ee86b5ab8c4fc89f97fb6/pyNonogram-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-02 14:24:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Apsurt",
"github_project": "pyNonogram",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
">=",
"1.19.5"
]
]
},
{
"name": "pytest",
"specs": [
[
">=",
"6.2.4"
]
]
}
],
"lcname": "pynonogram"
}
