| Name | tk-flow JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | None |
| Summary | Using the tkinter UI library to build flowcharts. |
| upload_time | 2024-12-16 19:33:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2024 ajcecil 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 |
flowchart
flow
flowcharts
charts
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## tk_flow
tk_flow is a python library structure to have the simplest flowchart capabilities using the existing tkinter library to produce the imagery and containing the ability to export the generated graphics to a pdf format.
## Function Usage
Currently this function can create different flowchart block shapes:
- rectangle
- oval
- diamond
- hexagon
The current shapes are the core flowchart items, each shape can be modified uniformly, with two rectangle options to have variants of the rectangle.
```python
from tk_flow import Flowchart
import tkinter as tk
# Set up window
root = tk.Tk()
example_flowchart = Flowchart()
# Node Creation
start = example_flowchart.node(col = 2, row = 0, text = 'Start', shape = 'terminal_start')
end = example_flowchart.node(col = 2,row = 4, text = 'End', shape = 'terminal_end')
example_flowchart.connect(node1 = start, direction1 = 's' , node2 = end, direction2 = 'n' , style = 'arrow' )
```
## Shapes/NodeTypes
- point (blank space to anchor lines in the flow)
- title
- label
- terminal_start (oval type node, designated as start node, by default filled green)
- terminal_end (oval type node, designated as end node, by default filled red)
- rectangle
- rectangle2
- diamond
- hexagon
- oval
## Formatting
Most of the formating Items are stored in a dictionary and can be edited individually.
```python
default_colors = {
"oval": "lightblue",
"rectangle": "lightgrey",
"rectangle2": "lightbrown",
"diamond": "lightgreen",
"hexagon": "lightyellow",
"terminal_start": "green",
"terminal_end": "red"
}
default_outlines = {
"oval": {"color": "black", "thickness": 2},
"rectangle": {"color": "black", "thickness": 2},
"rectangle2": {"color": "black", "thickness": 2},
"diamond": {"color": "black", "thickness": 2},
"hexagon": {"color": "black", "thickness": 2},
"terminal_start": {"color": "black", "thickness": 2},
"terminal_end": {"color": "black", "thickness": 2}
}
default_fonts = {
"oval": {"font": "Courier", "size": 24, "color": "black", "weight": "normal", "underline" : False},
"rectangle": {"font": "Courier", "size": 24, "color": "black", "weight": "normal", "underline" : False},
"rectangle2": {"font": "Courier", "size": 24, "color": "black", "weight": "bold", "underline" : False},
"diamond": {"font": "Courier", "size": 24, "color": "black", "weight": "normal", "underline" : False},
"hexagon": {"font": "Courier", "size": 24, "color": "black", "weight": "normal", "underline" : False},
"label": {"font": "Courier", "size": 18, "color": "black", "weight": "bold", "underline" : False},
"terminal_start": {"font": "Courier", "size": 66, "color": "black", "weight": "bold", "underline" : False},
"terminal_end": {"font": "Courier", "size": 66, "color": "black", "weight": "bold", "underline" : False},
"title": {"font": "Courier", "size": 72, "color": "black", "weight": "bold", "underline" : False}
}
default_connectors = {
"color": "black",
"thickness": 2
}
```
## Input Variables
```python
#input variable options
Flowchart(
root,
title="Flowchart Creator",
grid_width=100,
grid_height=100,
grid_pad=0.15,
colors=None,
outlines=None,
fonts=None,
connectors=None,
spacing=50,
node_width=150,
node_height=90,
label_width=25,
label_height=10
)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "tk-flow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Alex Cecil <ajcecil@iastate.edu>",
"keywords": "flowchart, flow, flowcharts, charts",
"author": null,
"author_email": "Alex Cecil <ajcecil@iastate.edu>",
"download_url": "https://files.pythonhosted.org/packages/90/39/521c06e0dff8e5d04e60122f98524d7ce8b82b82ff6ce9f9315c15aa4eaa/tk_flow-0.0.0.tar.gz",
"platform": null,
"description": "## tk_flow\ntk_flow is a python library structure to have the simplest flowchart capabilities using the existing tkinter library to produce the imagery and containing the ability to export the generated graphics to a pdf format.\n\n\n\n\n\n\n## Function Usage\nCurrently this function can create different flowchart block shapes:\n- rectangle\n- oval\n- diamond\n- hexagon\n\nThe current shapes are the core flowchart items, each shape can be modified uniformly, with two rectangle options to have variants of the rectangle. \n\n```python\nfrom tk_flow import Flowchart\nimport tkinter as tk\n\n# Set up window\nroot = tk.Tk()\nexample_flowchart = Flowchart() \n\n\n# Node Creation\nstart = example_flowchart.node(col = 2, row = 0, text = 'Start', shape = 'terminal_start')\nend = example_flowchart.node(col = 2,row = 4, text = 'End', shape = 'terminal_end')\n\nexample_flowchart.connect(node1 = start, direction1 = 's' , node2 = end, direction2 = 'n' , style = 'arrow' )\n\n```\n\n\n## Shapes/NodeTypes\n- point (blank space to anchor lines in the flow)\n- title\n- label\n- terminal_start (oval type node, designated as start node, by default filled green)\n- terminal_end (oval type node, designated as end node, by default filled red)\n- rectangle\n- rectangle2\n- diamond\n- hexagon\n- oval\n\n\n## Formatting\nMost of the formating Items are stored in a dictionary and can be edited individually.\n```python\ndefault_colors = {\n \"oval\": \"lightblue\",\n \"rectangle\": \"lightgrey\",\n \"rectangle2\": \"lightbrown\",\n \"diamond\": \"lightgreen\",\n \"hexagon\": \"lightyellow\",\n \"terminal_start\": \"green\",\n \"terminal_end\": \"red\"\n }\n\ndefault_outlines = {\n \"oval\": {\"color\": \"black\", \"thickness\": 2},\n \"rectangle\": {\"color\": \"black\", \"thickness\": 2},\n \"rectangle2\": {\"color\": \"black\", \"thickness\": 2},\n \"diamond\": {\"color\": \"black\", \"thickness\": 2},\n \"hexagon\": {\"color\": \"black\", \"thickness\": 2},\n \"terminal_start\": {\"color\": \"black\", \"thickness\": 2},\n \"terminal_end\": {\"color\": \"black\", \"thickness\": 2}\n }\n\ndefault_fonts = {\n \"oval\": {\"font\": \"Courier\", \"size\": 24, \"color\": \"black\", \"weight\": \"normal\", \"underline\" : False},\n \"rectangle\": {\"font\": \"Courier\", \"size\": 24, \"color\": \"black\", \"weight\": \"normal\", \"underline\" : False},\n \"rectangle2\": {\"font\": \"Courier\", \"size\": 24, \"color\": \"black\", \"weight\": \"bold\", \"underline\" : False},\n \"diamond\": {\"font\": \"Courier\", \"size\": 24, \"color\": \"black\", \"weight\": \"normal\", \"underline\" : False},\n \"hexagon\": {\"font\": \"Courier\", \"size\": 24, \"color\": \"black\", \"weight\": \"normal\", \"underline\" : False},\n \"label\": {\"font\": \"Courier\", \"size\": 18, \"color\": \"black\", \"weight\": \"bold\", \"underline\" : False},\n \"terminal_start\": {\"font\": \"Courier\", \"size\": 66, \"color\": \"black\", \"weight\": \"bold\", \"underline\" : False},\n \"terminal_end\": {\"font\": \"Courier\", \"size\": 66, \"color\": \"black\", \"weight\": \"bold\", \"underline\" : False},\n \"title\": {\"font\": \"Courier\", \"size\": 72, \"color\": \"black\", \"weight\": \"bold\", \"underline\" : False}\n }\n\ndefault_connectors = {\n \"color\": \"black\",\n \"thickness\": 2\n }\n\n\n```\n\n\n## Input Variables\n```python\n#input variable options\nFlowchart(\n root,\n title=\"Flowchart Creator\",\n grid_width=100,\n grid_height=100,\n grid_pad=0.15,\n colors=None,\n outlines=None,\n fonts=None,\n connectors=None,\n spacing=50,\n node_width=150,\n node_height=90,\n label_width=25,\n label_height=10\n)\n``` \n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 ajcecil 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": "Using the tkinter UI library to build flowcharts.",
"version": "0.0.0",
"project_urls": {
"Repository": "https://github.com/ajcecil/tk_flow.git"
},
"split_keywords": [
"flowchart",
" flow",
" flowcharts",
" charts"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df50403ee939c188881d54de8e7c84b56ed16f2fa203ec4378cce1535430181b",
"md5": "9ecd366e8f89bf64ab01def8ae9fb56f",
"sha256": "378580915e48a799833c0c9eda7a2d617f50dc0595d6d994466d022dbd779300"
},
"downloads": -1,
"filename": "tk_flow-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ecd366e8f89bf64ab01def8ae9fb56f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8424,
"upload_time": "2024-12-16T19:33:28",
"upload_time_iso_8601": "2024-12-16T19:33:28.171437Z",
"url": "https://files.pythonhosted.org/packages/df/50/403ee939c188881d54de8e7c84b56ed16f2fa203ec4378cce1535430181b/tk_flow-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9039521c06e0dff8e5d04e60122f98524d7ce8b82b82ff6ce9f9315c15aa4eaa",
"md5": "fef271a2f5e5b849f3c069fbbbe25d01",
"sha256": "7fde5223f65fd4677387bb3de44623d92b518f9b063421df159187a238858923"
},
"downloads": -1,
"filename": "tk_flow-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "fef271a2f5e5b849f3c069fbbbe25d01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9738,
"upload_time": "2024-12-16T19:33:29",
"upload_time_iso_8601": "2024-12-16T19:33:29.945420Z",
"url": "https://files.pythonhosted.org/packages/90/39/521c06e0dff8e5d04e60122f98524d7ce8b82b82ff6ce9f9315c15aa4eaa/tk_flow-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 19:33:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ajcecil",
"github_project": "tk_flow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tk-flow"
}
