# Welcome to sketchpy
<h2>Intro to the project and some quick information,followed by an image of the project.<h2>
<div align="center">
<img src = 'https://user-images.githubusercontent.com/80098044/163577650-cd52c226-5cc2-464f-a5b2-a647a4924cc6.jpg'>
</div>
## Description
This is the beginning level python project to do some awesome drawing animation using the `turtle` module, hope it grows in the future
It is a Python module for animating drawings of images. The sketchpy module is created on top of the turtle module in Python.
To install sketchpy on your computer, you can go to your command prompt (command line) and run the following command.
### Usage
- Just install the package `pip install sketchpy`
- Import it to you project `import sketchpy` and use as you want😊
### Built with
- Turtle
- Open-cv
- Pillow
- numpy
- Svgpathtools
## Getting started
### Prerequisites
- Python
- Basic text editor
- creativity😂
### Install
```
pip install sketchpy
```
it should probably work, If not then try the following code
```
pip install turtle open-cv wheel sketchpy
```
### Example
Open your code editor and write the example Python code snippets given below. Run your code and see the magic by yourself.
## Drawing Robert Downey Jr. Using Python
```
from sketchpy import library as lib
obj = lib.rdj()
obj.draw()
```
### OUTPUT
<div align = "center">
<img src = "https://user-images.githubusercontent.com/80098044/154792552-59c53805-35b9-46e0-be37-2c5dae0a87d1.gif">
</div>
## Drawing Tom Holland Using Python
```
from sketchpy import library
myObject = library.tom_holland()
myObject.draw()
```
## OUTPUT
<div align = "center">
<img src = "https://cdn-0.pythonistaplanet.com/wp-content/uploads/2022/05/image-5.png?ezimgfmt=ng:webp/ngcb19">
</div>
## More examples
```
from sketchpy import library as lib
obj = lib.bts()
obj.draw()
```
```
from sketchpy import library as lib
obj = lib.vijay()
obj.draw()
```
<div align = 'center' style = "display: flex; justify-content: space-between;">
<img src = "https://user-images.githubusercontent.com/80098044/154793329-e8ec9635-b49e-4898-8a3e-6462645d6c8c.gif" height = 180 width = 214>
<img src = "https://user-images.githubusercontent.com/80098044/154793382-6d012c24-adbf-4c5a-bd51-b5095a34e9fe.gif" height = 180 width = 214>
</div>
## Drawing Iron Man ASCII Animation Using Python
```
from sketchpy import library
myObject = library.ironman_ascii()
myObject.draw()
```
## OUTPUT
<div align = "center">
<img src = "https://cdn-0.pythonistaplanet.com/wp-content/uploads/2022/05/image-8.png?ezimgfmt=ng:webp/ngcb19">
</div>
# Drawing from `SVG` file
Use the following code to draw a file from svg file, insted of tracing full image
#### NOTE: use this specific website to convert image to svg, sketchpy is specifically made to work with this [website](https://svgconvert.com/#/) only
```
from sketchpy import canvas
obj = canvas.sketch_from_svg('FILE PATH')
obj.draw()
```
# `Saving` a loaded svg file
Insted of waiting for the svg file to load, you can save as .npy file and use that for future use
```
from sketchpy import canvas
obj = canvas.sketch_from_svg('FILE PATH')
obj.load_svg(filename = 'data.npy')
```
## Drawing form `.npy` file
use the following code to draw your image from saved data file
```
from sketchpy import canvas
obj = canvas.sketch_from_svg('FILE PATH')
obj.draw(filename = 'data.npy')
```
## Drawing from `raw image`
use the following code to draw any image, it need not to be an svg file
```
from sketchpy import canvas
obj = canvas.sketch_from_image('IMAGE PATH')
obj.draw(threshold = 127)
```
#### NOTE: you can change the value of threshold to draw more detailed image, it's range is 0 - 255,use values between 90-190
### Troubleshooting
- If you find any problem, you can pull request, or contact me on either [insta](https://www.instagram.com/mr.m_y_s_t_e_r_y/) or [discord](https://discord.gg/r2KFa73PM2)
- You can also find video on my [youtube channel](https://www.youtube.com/playlist?list=PLb1Kbw_2jl_mr3A_cl6pXA1N5lwtHCx_7)
### Acknowledgements
Thanks to all who helped inspire this project.❤
### See also
- [Youtube Videos](https://www.youtube.com/playlist?list=PLb1Kbw_2jl_mr3A_cl6pXA1N5lwtHCx_7)
- [Related Blogs](https://codehub0.blogspot.com/)
- [Contact me on Discord](https://discord.gg/r2KFa73PM2)
- [My insta ID](https://www.instagram.com/mr.m_y_s_t_e_r_y/)
### Consider supporting me
- upi id sriramanand23@okicici
- scan and encourage us to develop more features
- even one rupee make a huge difference
### License
This project is licensed under the [MIT License](https://github.com/MRMYSTERY003/sketchpy/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "sketchpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,sketch,drawing,animation,code hub,pencil sketch,painting,sketchpy,draw,sketching",
"author": "Mr Mystery",
"author_email": "sriramanand23@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2d/25/61ad1cb2feaa3c9b7fdb192dd1f9b398b43b2a3b9e53e769bf576d80cca7/sketchpy-0.1.8.tar.gz",
"platform": null,
"description": "\n# Welcome to sketchpy\n\n<h2>Intro to the project and some quick information,followed by an image of the project.<h2>\n\n<div align=\"center\">\n <img src = 'https://user-images.githubusercontent.com/80098044/163577650-cd52c226-5cc2-464f-a5b2-a647a4924cc6.jpg'>\n</div>\n\n## Description\n\nThis is the beginning level python project to do some awesome drawing animation using the `turtle` module, hope it grows in the future\nIt is a Python module for animating drawings of images. The sketchpy module is created on top of the turtle module in Python.\nTo install sketchpy on your computer, you can go to your command prompt (command line) and run the following command.\n\n### Usage\n\n- Just install the package `pip install sketchpy`\n- Import it to you project `import sketchpy` and use as you want\ud83d\ude0a\n\n### Built with\n\n- Turtle \n- Open-cv\n- Pillow\n- numpy\n- Svgpathtools\n\n## Getting started\n\n### Prerequisites\n\n- Python\n- Basic text editor\n- creativity\ud83d\ude02\n\n### Install\n\n```\n pip install sketchpy\n```\nit should probably work, If not then try the following code\n\n```\n pip install turtle open-cv wheel sketchpy\n```\n\n\n### Example\n\nOpen your code editor and write the example Python code snippets given below. Run your code and see the magic by yourself.\n\n\n## Drawing Robert Downey Jr. Using Python\n\n```\n from sketchpy import library as lib\n obj = lib.rdj()\n obj.draw()\n```\n\n### OUTPUT\n<div align = \"center\">\n <img src = \"https://user-images.githubusercontent.com/80098044/154792552-59c53805-35b9-46e0-be37-2c5dae0a87d1.gif\">\n</div>\n\n\n\n## Drawing Tom Holland Using Python\n\n```\n from sketchpy import library\n myObject = library.tom_holland()\n myObject.draw()\n```\n\n\n## OUTPUT\n<div align = \"center\">\n <img src = \"https://cdn-0.pythonistaplanet.com/wp-content/uploads/2022/05/image-5.png?ezimgfmt=ng:webp/ngcb19\">\n</div>\n\n## More examples\n\n```\n from sketchpy import library as lib\n\n obj = lib.bts()\n obj.draw()\n```\n\n```\n from sketchpy import library as lib\n\n obj = lib.vijay()\n obj.draw()\n```\n<div align = 'center' style = \"display: flex; justify-content: space-between;\"> \n<img src = \"https://user-images.githubusercontent.com/80098044/154793329-e8ec9635-b49e-4898-8a3e-6462645d6c8c.gif\" height = 180 width = 214>\n<img src = \"https://user-images.githubusercontent.com/80098044/154793382-6d012c24-adbf-4c5a-bd51-b5095a34e9fe.gif\" height = 180 width = 214>\n</div>\n\n## Drawing Iron Man ASCII Animation Using Python\n\n```\n from sketchpy import library\n myObject = library.ironman_ascii()\n myObject.draw()\n```\n\n## OUTPUT\n\n<div align = \"center\">\n <img src = \"https://cdn-0.pythonistaplanet.com/wp-content/uploads/2022/05/image-8.png?ezimgfmt=ng:webp/ngcb19\">\n</div>\n\n\n\n# Drawing from `SVG` file\n\nUse the following code to draw a file from svg file, insted of tracing full image\n\n#### NOTE: use this specific website to convert image to svg, sketchpy is specifically made to work with this [website](https://svgconvert.com/#/) only\n\n```\n from sketchpy import canvas\n obj = canvas.sketch_from_svg('FILE PATH')\n obj.draw()\n```\n\n# `Saving` a loaded svg file\n\nInsted of waiting for the svg file to load, you can save as .npy file and use that for future use\n\n```\n from sketchpy import canvas\n obj = canvas.sketch_from_svg('FILE PATH')\n obj.load_svg(filename = 'data.npy')\n```\n\n## Drawing form `.npy` file\n\nuse the following code to draw your image from saved data file\n\n```\n from sketchpy import canvas\n obj = canvas.sketch_from_svg('FILE PATH')\n obj.draw(filename = 'data.npy')\n``` \n\n## Drawing from `raw image`\n\nuse the following code to draw any image, it need not to be an svg file\n```\n from sketchpy import canvas\n obj = canvas.sketch_from_image('IMAGE PATH')\n obj.draw(threshold = 127)\n```\n#### NOTE: you can change the value of threshold to draw more detailed image, it's range is 0 - 255,use values between 90-190\n\n### Troubleshooting\n\n- If you find any problem, you can pull request, or contact me on either [insta](https://www.instagram.com/mr.m_y_s_t_e_r_y/) or [discord](https://discord.gg/r2KFa73PM2)\n- You can also find video on my [youtube channel](https://www.youtube.com/playlist?list=PLb1Kbw_2jl_mr3A_cl6pXA1N5lwtHCx_7)\n\n\n\n\n### Acknowledgements\n\nThanks to all who helped inspire this project.\u2764\n\n### See also\n\n- [Youtube Videos](https://www.youtube.com/playlist?list=PLb1Kbw_2jl_mr3A_cl6pXA1N5lwtHCx_7)\n- [Related Blogs](https://codehub0.blogspot.com/)\n- [Contact me on Discord](https://discord.gg/r2KFa73PM2)\n- [My insta ID](https://www.instagram.com/mr.m_y_s_t_e_r_y/)\n\n### Consider supporting me\n\n- upi id sriramanand23@okicici\n- scan and encourage us to develop more features\n- even one rupee make a huge difference\n\n\n\n\n### License\n\nThis project is licensed under the [MIT License](https://github.com/MRMYSTERY003/sketchpy/blob/main/LICENSE).\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "sketchpy",
"version": "0.1.8",
"project_urls": null,
"split_keywords": [
"python",
"sketch",
"drawing",
"animation",
"code hub",
"pencil sketch",
"painting",
"sketchpy",
"draw",
"sketching"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36188bd82e50e3a6e00c8911a42c931c9a4ac618746933ae6dedafe9696b2375",
"md5": "107bbace145be926734727790aa93c7b",
"sha256": "107765975e1fc5b5a49dbbab472cb0a3f85a8dd35a0d043e4b008826e4e93314"
},
"downloads": -1,
"filename": "sketchpy-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "107bbace145be926734727790aa93c7b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 44862,
"upload_time": "2024-01-05T09:36:32",
"upload_time_iso_8601": "2024-01-05T09:36:32.025516Z",
"url": "https://files.pythonhosted.org/packages/36/18/8bd82e50e3a6e00c8911a42c931c9a4ac618746933ae6dedafe9696b2375/sketchpy-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d2561ad1cb2feaa3c9b7fdb192dd1f9b398b43b2a3b9e53e769bf576d80cca7",
"md5": "35499465f70133c586039cb106f8c4f2",
"sha256": "24d6b3307e803ef460603c9d2f43aea8cb3c22e71964dbeeca0548e3dee623d5"
},
"downloads": -1,
"filename": "sketchpy-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "35499465f70133c586039cb106f8c4f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 47519,
"upload_time": "2024-01-05T09:36:34",
"upload_time_iso_8601": "2024-01-05T09:36:34.425605Z",
"url": "https://files.pythonhosted.org/packages/2d/25/61ad1cb2feaa3c9b7fdb192dd1f9b398b43b2a3b9e53e769bf576d80cca7/sketchpy-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-05 09:36:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sketchpy"
}
JSON