[](https://travis-ci.com/ladybug-tools/ladybug-geometry-polyskel)
[](https://coveralls.io/github/ladybug-tools/ladybug-geometry-polyskel)
[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# ladybug-geometry-polyskel
A library with straight skeleton methods using ladybug-geometry.
## Credits
Ladybug-geometry-polyskel is a derivative work of the the [polyskel package](https://github.com/Botffy/polyskel)
by [Ármin Scipiades](https://github.com/Botffy) (@Bottfy), which is, itself, a Python 3
implementation of the straight skeleton algorithm as described by Felkel and Obdržálek
in their 1998 conference paper [Straight skeleton implementation](https://github.com/Botffy/polyskel/blob/master/doc/StraightSkeletonImplementation.pdf).
Key differences between Bottfy's original implementation and this package are:
* It has been modified for compatibility with both Python 2.7 and Python 3.7.
* The code as been re-stylized to conform to the PEP8 style guide.
* Modules have been added to extract core/perimeter polygons from the straight skeleton.
## Installation
```console
pip install -U ladybug-geometry-polyskel
```
## QuickStart
```python
import ladybug_geometry_polyskel
```
## [API Documentation](http://ladybug-tools.github.io/ladybug-geometry-polyskel/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/ladybug-geometry-polyskel
# or
git clone https://github.com/ladybug-tools/ladybug-geometry-polyskel
```
2. Install dependencies:
```console
cd ladybug-geometry-polyskel
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_geometry_polyskel
sphinx-build -b html ./docs ./docs/_build/docs
```
## Copyright
Ladybug Geometry Polyskel, Copyright (c) 2021, Ármin Scipiades, Ladybug Tools LLC
and other contributors. All rights reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/ladybug-geometry-polyskel",
"name": "ladybug-geometry-polyskel",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/db/6f/853da7428876650b854f835c00d0678646ea5e72637091ea2b97f4a13f67/ladybug-geometry-polyskel-1.4.40.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/ladybug-tools/ladybug-geometry-polyskel)\n[](https://coveralls.io/github/ladybug-tools/ladybug-geometry-polyskel)\n\n[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# ladybug-geometry-polyskel\n\nA library with straight skeleton methods using ladybug-geometry.\n\n## Credits\n\nLadybug-geometry-polyskel is a derivative work of the the [polyskel package](https://github.com/Botffy/polyskel)\nby [\u00c1rmin Scipiades](https://github.com/Botffy) (@Bottfy), which is, itself, a Python 3\nimplementation of the straight skeleton algorithm as described by Felkel and Obdr\u017e\u00e1lek\nin their 1998 conference paper [Straight skeleton implementation](https://github.com/Botffy/polyskel/blob/master/doc/StraightSkeletonImplementation.pdf).\n\nKey differences between Bottfy's original implementation and this package are:\n\n* It has been modified for compatibility with both Python 2.7 and Python 3.7.\n* The code as been re-stylized to conform to the PEP8 style guide.\n* Modules have been added to extract core/perimeter polygons from the straight skeleton.\n\n## Installation\n\n```console\npip install -U ladybug-geometry-polyskel\n```\n\n## QuickStart\n\n```python\nimport ladybug_geometry_polyskel\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/ladybug-geometry-polyskel/docs)\n\n## Local Development\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/ladybug-geometry-polyskel\n\n# or\n\ngit clone https://github.com/ladybug-tools/ladybug-geometry-polyskel\n```\n2. Install dependencies:\n```console\ncd ladybug-geometry-polyskel\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./ladybug_geometry_polyskel\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n\n## Copyright \n\nLadybug Geometry Polyskel, Copyright (c) 2021, \u00c1rmin Scipiades, Ladybug Tools LLC\nand other contributors. All rights reserved.\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "A library with poly skeleton methods using ladybug-geometry",
"version": "1.4.40",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/ladybug-geometry-polyskel"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db26a973a266d2247eca18163e5f37a8f5e89e7f3725593f001178cc88238be5",
"md5": "bb073f0df9067e86bc179abfca165bd0",
"sha256": "975e65e3e290f0206dc5ae9ea6f18b31d58275acadf6eb2b0224cd85577ea4da"
},
"downloads": -1,
"filename": "ladybug_geometry_polyskel-1.4.40-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb073f0df9067e86bc179abfca165bd0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 32230,
"upload_time": "2024-04-20T00:03:54",
"upload_time_iso_8601": "2024-04-20T00:03:54.453150Z",
"url": "https://files.pythonhosted.org/packages/db/26/a973a266d2247eca18163e5f37a8f5e89e7f3725593f001178cc88238be5/ladybug_geometry_polyskel-1.4.40-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db6f853da7428876650b854f835c00d0678646ea5e72637091ea2b97f4a13f67",
"md5": "816807e2037a9359ef6fa1017edb9217",
"sha256": "6839e78ab57b3323b7c5aab33ba19d8854fb8e72fb26df8d111e0e86edea5a0e"
},
"downloads": -1,
"filename": "ladybug-geometry-polyskel-1.4.40.tar.gz",
"has_sig": false,
"md5_digest": "816807e2037a9359ef6fa1017edb9217",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 48497,
"upload_time": "2024-04-20T00:03:56",
"upload_time_iso_8601": "2024-04-20T00:03:56.687460Z",
"url": "https://files.pythonhosted.org/packages/db/6f/853da7428876650b854f835c00d0678646ea5e72637091ea2b97f4a13f67/ladybug-geometry-polyskel-1.4.40.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-20 00:03:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "ladybug-geometry-polyskel",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ladybug-geometry-polyskel"
}
JSON
