# svgsimplegraph
This is a simple little graphing package for making graphs and exporting them as raw or base64-encoded SVGs.
You can also upload the SVGs to your GitHub account as Gists, so they may be embedded in any website!
## Installing svgsimplegraph
Install svgsimplegraph by typing
```
pip install svgsimplegraph
```
in your terminal.
## Graph Types
### Categorical Graph
The categorical graph is for data that comes in distinct categories. It can generate a bar chart, a stacked bar chart, dots, or lines.
Here is an example of how to make a graph:
```
from svgsimplegraph import CategoricalGraph
graph = CategoricalGraph(
width=600,
height=400,
bar_width=30,
stacked=False,
background_color="#404040",
title="Categorical Graph",
)
graph.x_labels = ["A", "B", "C", "D", "E"]
graph.x_axis_label = "X Axis"
graph.primary_y_axis_label = "Primary Y Axis"
# Skip adding a legend_label to exclude a series from the legend
graph.add_series([10, 20, 30, 40, 50], legend_label="Series 1")
graph.add_series([15, 25, 5, 44, 56], legend_label="Series 2")
graph.add_series([5, 35, 10, 33, 40], legend_label="Series 3", series_type="line")
graph.add_series([35, 56, 25, 5, 44], legend_label="Series 4", series_type="dot")
# You can use vertical or horizontal lines to mark specific values
graph.add_vertical_line(
x=2.5,
label="Vertical Line",
label_x_position="right",
label_y_position="top",
rotate_label=True,
)
# Get the SVG string in base64 format
svg_base64 = graph.to_base64_src()
# Print the SVG string in an img tag so your browser can display it
print(f"\n<img src='{svg_base64}' />")
# Alternatively, you can get the raw SVG code with render()
raw_svg = graph.render()
print(raw_svg)
```
### Ribbon Graph
The ribbon graph is for comparing two numbers on the same scale and a third number on a different scale (represented through color).
The three series must be added in order, with the first representing the back of the ribbon, the second representing the point, and the (optional) third representing the color.
Here's an example:
```
from svgsimplegraph import RibbonGraph
graph = RibbonGraph(
width=600,
height=400,
bar_width=30,
background_color="#404040",
title="Ribbon Graph",
)
graph.x_labels = ["A", "B", "C", "D", "E"]
graph.x_axis_label = "X Axis"
graph.primary_y_axis_label = "Primary Y Axis"
graph.add_series([10, 20, 30, 40, 50], legend_label="Series 1", print_values=True)
graph.add_series([20, 30, 40, 30, 20], legend_label="Series 2", print_values=True)
graph.add_series(
[-10, -20, 30, 20, 10], legend_label="Color Series", print_values=True
)
# Get the SVG string in base64 format
svg_base64 = graph.to_base64_src()
# Print the SVG string in an img tag so your browser can display it
print(f"\n<img src='{svg_base64}' />")
# Alternatively, you can get the raw SVG code with render()
raw_svg = graph.render()
print(raw_svg)
```
### Bubble and Arrow Graph
The bubble and arrow graph is for displaying relationships between nodes in a network.
The user adds bubbles, which are displayed in clockwise order around a larger circle. Then the user can add arrows that exit from one bubble and enter another. Arrow width is scaled to show more important connections.
Here's an example:
```
from svgsimplegraph import BubbleAndArrowGraph
graph = BubbleAndArrowGraph(
width=400,
height=400,
background_color="#ffffff",
title="Bubble and Arrow Graph",
)
# Optional str label param can be referred to later when defining arrows
graph.add_bubble(100, None, "Bubble 0", label="big_bubble")
# Otherwise bubbles must be referred to by their index number
graph.add_bubble(50, 25, "Bubble 1")
graph.add_bubble(25, 12.5, "Bubble 2")
graph.add_arrow(
origin="big_bubble",
destination=1,
size=60,
)
graph.add_arrow(
origin="big_bubble",
destination=2,
size=40,
)
graph.add_arrow(
origin=1,
destination=2,
size=30,
)
# Arrows pointing to their origin will loop around
graph.add_arrow(
origin=2,
destination=2,
size=20,
)
# Get the SVG string in base64 format
svg_base64 = graph.to_base64_src()
# Print the SVG string in an img tag so your browser can display it
print(f"\n<img src='{svg_base64}' />")
# Alternatively, you can get the raw SVG code with render()
raw_svg = graph.render()
print(raw_svg)
```
## GitHub Gist integration
The `upload_to_github_gist` function allows you to render your graph and upload it to your GitHub account as a Gist.
To do this, you'll need an access token. Go to your github account and navigate to settings. Then click on Developer settings > Personal access tokens > Fine-grained tokens.
Click the Generate new token button in the top right of the screen. GitHub will prompt you to login. Set a token name (something like "gist-access-token") and an expiration.
Scroll down to Permissions and expand the Account permissions box. Then turn on read and write access for Gists only (you should not use this token for anything else). Finally, click the gree Generate token button at the bottom of the screen.
Now you should see a screen showing your token. This is the only time Github will show you this token, so save it somewhere safe.
Assuming you've done all that, you can use the token to turn your graphs into gists.
```
from svgsimplegraph import CategoricalGraph
GITHUB_ACCESS_TOKEN = "your_token_goes_here"
# Create an instance of a graph
graph = CategoricalGraph(
width=600,
height=400,
bar_width=30,
stacked=False,
background_color="#404040",
)
graph.x_labels = ["A", "B", "C", "D", "E"]
graph.x_axis_label = "X Axis"
graph.primary_y_axis_label = "Primary Y Axis"
graph.add_series([10, 20, 30, 40, 50], legend_label="Series 1")
svg_url = graph.upload_to_github_gist(GITHUB_ACCESS_TOKEN, "my_categorical_graph")
```
The `svg_url` variable now contains a string with the url of your new SVG, ready to be embedded in any website!
## Watermarks
When you initialize a graph, you can use the watermark variable to add arbitrary svg code to the graph. It is recommended to make your watermark partially transparent, as it will be placed on top of your graph.
Raw data
{
"_id": null,
"home_page": null,
"name": "svgsimplegraph",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "graph, svg, base64, svg simple graph",
"author": "Garrett M. Petersen",
"author_email": "garrett.m.petersen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/33/f2/5c70f15a3911ca02d81c5524edcda28495701d18a8543f3f42b9e4aec85a/svgsimplegraph-0.3.1.tar.gz",
"platform": null,
"description": "# svgsimplegraph\n\nThis is a simple little graphing package for making graphs and exporting them as raw or base64-encoded SVGs.\n\nYou can also upload the SVGs to your GitHub account as Gists, so they may be embedded in any website!\n\n## Installing svgsimplegraph\nInstall svgsimplegraph by typing\n```\npip install svgsimplegraph\n```\nin your terminal.\n\n## Graph Types\n### Categorical Graph\n\nThe categorical graph is for data that comes in distinct categories. It can generate a bar chart, a stacked bar chart, dots, or lines.\n\nHere is an example of how to make a graph:\n\n```\nfrom svgsimplegraph import CategoricalGraph\n\ngraph = CategoricalGraph(\n width=600,\n height=400,\n bar_width=30,\n stacked=False,\n background_color=\"#404040\",\n title=\"Categorical Graph\",\n )\n\ngraph.x_labels = [\"A\", \"B\", \"C\", \"D\", \"E\"]\ngraph.x_axis_label = \"X Axis\"\ngraph.primary_y_axis_label = \"Primary Y Axis\"\n\n# Skip adding a legend_label to exclude a series from the legend\ngraph.add_series([10, 20, 30, 40, 50], legend_label=\"Series 1\")\ngraph.add_series([15, 25, 5, 44, 56], legend_label=\"Series 2\")\ngraph.add_series([5, 35, 10, 33, 40], legend_label=\"Series 3\", series_type=\"line\")\ngraph.add_series([35, 56, 25, 5, 44], legend_label=\"Series 4\", series_type=\"dot\")\n\n# You can use vertical or horizontal lines to mark specific values\ngraph.add_vertical_line(\n x=2.5,\n label=\"Vertical Line\",\n label_x_position=\"right\",\n label_y_position=\"top\",\n rotate_label=True,\n)\n\n# Get the SVG string in base64 format\nsvg_base64 = graph.to_base64_src()\n\n# Print the SVG string in an img tag so your browser can display it\nprint(f\"\\n<img src='{svg_base64}' />\")\n\n# Alternatively, you can get the raw SVG code with render()\nraw_svg = graph.render()\nprint(raw_svg)\n```\n\n\n### Ribbon Graph\n\nThe ribbon graph is for comparing two numbers on the same scale and a third number on a different scale (represented through color).\n\nThe three series must be added in order, with the first representing the back of the ribbon, the second representing the point, and the (optional) third representing the color.\n\nHere's an example:\n\n```\nfrom svgsimplegraph import RibbonGraph\n\ngraph = RibbonGraph(\n width=600,\n height=400,\n bar_width=30,\n background_color=\"#404040\",\n title=\"Ribbon Graph\",\n)\n\ngraph.x_labels = [\"A\", \"B\", \"C\", \"D\", \"E\"]\ngraph.x_axis_label = \"X Axis\"\ngraph.primary_y_axis_label = \"Primary Y Axis\"\n\ngraph.add_series([10, 20, 30, 40, 50], legend_label=\"Series 1\", print_values=True)\ngraph.add_series([20, 30, 40, 30, 20], legend_label=\"Series 2\", print_values=True)\ngraph.add_series(\n [-10, -20, 30, 20, 10], legend_label=\"Color Series\", print_values=True\n)\n\n# Get the SVG string in base64 format\nsvg_base64 = graph.to_base64_src()\n\n# Print the SVG string in an img tag so your browser can display it\nprint(f\"\\n<img src='{svg_base64}' />\")\n\n# Alternatively, you can get the raw SVG code with render()\nraw_svg = graph.render()\nprint(raw_svg)\n```\n\n\n### Bubble and Arrow Graph\nThe bubble and arrow graph is for displaying relationships between nodes in a network.\n\nThe user adds bubbles, which are displayed in clockwise order around a larger circle. Then the user can add arrows that exit from one bubble and enter another. Arrow width is scaled to show more important connections.\n\nHere's an example:\n```\nfrom svgsimplegraph import BubbleAndArrowGraph\n\ngraph = BubbleAndArrowGraph(\n width=400,\n height=400,\n background_color=\"#ffffff\",\n title=\"Bubble and Arrow Graph\",\n)\n\n# Optional str label param can be referred to later when defining arrows\ngraph.add_bubble(100, None, \"Bubble 0\", label=\"big_bubble\")\n\n# Otherwise bubbles must be referred to by their index number\ngraph.add_bubble(50, 25, \"Bubble 1\")\ngraph.add_bubble(25, 12.5, \"Bubble 2\")\n\ngraph.add_arrow(\n origin=\"big_bubble\",\n destination=1,\n size=60,\n)\ngraph.add_arrow(\n origin=\"big_bubble\",\n destination=2,\n size=40,\n)\ngraph.add_arrow(\n origin=1,\n destination=2,\n size=30,\n)\n\n# Arrows pointing to their origin will loop around\ngraph.add_arrow(\n origin=2,\n destination=2,\n size=20,\n)\n\n# Get the SVG string in base64 format\nsvg_base64 = graph.to_base64_src()\n\n# Print the SVG string in an img tag so your browser can display it\nprint(f\"\\n<img src='{svg_base64}' />\")\n\n# Alternatively, you can get the raw SVG code with render()\nraw_svg = graph.render()\nprint(raw_svg)\n```\n\n\n## GitHub Gist integration\n\nThe `upload_to_github_gist` function allows you to render your graph and upload it to your GitHub account as a Gist.\n\nTo do this, you'll need an access token. Go to your github account and navigate to settings. Then click on Developer settings > Personal access tokens > Fine-grained tokens.\n\nClick the Generate new token button in the top right of the screen. GitHub will prompt you to login. Set a token name (something like \"gist-access-token\") and an expiration.\n\nScroll down to Permissions and expand the Account permissions box. Then turn on read and write access for Gists only (you should not use this token for anything else). Finally, click the gree Generate token button at the bottom of the screen.\n\nNow you should see a screen showing your token. This is the only time Github will show you this token, so save it somewhere safe.\n\nAssuming you've done all that, you can use the token to turn your graphs into gists.\n\n```\nfrom svgsimplegraph import CategoricalGraph\n\nGITHUB_ACCESS_TOKEN = \"your_token_goes_here\"\n\n# Create an instance of a graph\ngraph = CategoricalGraph(\n width=600,\n height=400,\n bar_width=30,\n stacked=False,\n background_color=\"#404040\",\n)\n\ngraph.x_labels = [\"A\", \"B\", \"C\", \"D\", \"E\"]\ngraph.x_axis_label = \"X Axis\"\ngraph.primary_y_axis_label = \"Primary Y Axis\"\n\ngraph.add_series([10, 20, 30, 40, 50], legend_label=\"Series 1\")\n\nsvg_url = graph.upload_to_github_gist(GITHUB_ACCESS_TOKEN, \"my_categorical_graph\")\n```\n\nThe `svg_url` variable now contains a string with the url of your new SVG, ready to be embedded in any website!\n\n## Watermarks\n\nWhen you initialize a graph, you can use the watermark variable to add arbitrary svg code to the graph. It is recommended to make your watermark partially transparent, as it will be placed on top of your graph.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple SVG graphing package",
"version": "0.3.1",
"project_urls": {
"Source Code": "https://github.com/GarrettPetersen/svgsimplegraph"
},
"split_keywords": [
"graph",
" svg",
" base64",
" svg simple graph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d1db8f40f6dda557624ce51db11ce13f037a5a4a66cddcac7164a6fe4d5dc60",
"md5": "b08566c3817c263a826a7c40d395c3f5",
"sha256": "dd221031c0fec2cd8c50240bf3adaa10d099ea1e9251a419b24a8056074d5af3"
},
"downloads": -1,
"filename": "svgsimplegraph-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b08566c3817c263a826a7c40d395c3f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 30009,
"upload_time": "2024-04-19T18:36:15",
"upload_time_iso_8601": "2024-04-19T18:36:15.152792Z",
"url": "https://files.pythonhosted.org/packages/4d/1d/b8f40f6dda557624ce51db11ce13f037a5a4a66cddcac7164a6fe4d5dc60/svgsimplegraph-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33f25c70f15a3911ca02d81c5524edcda28495701d18a8543f3f42b9e4aec85a",
"md5": "70480b3af80143e4f5c10926d83efe5f",
"sha256": "aa925f8f689cfb068cec7b4bcfcab3c7528d943da771fd6455b1bad5b71b4569"
},
"downloads": -1,
"filename": "svgsimplegraph-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "70480b3af80143e4f5c10926d83efe5f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27454,
"upload_time": "2024-04-19T18:36:16",
"upload_time_iso_8601": "2024-04-19T18:36:16.920397Z",
"url": "https://files.pythonhosted.org/packages/33/f2/5c70f15a3911ca02d81c5524edcda28495701d18a8543f3f42b9e4aec85a/svgsimplegraph-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 18:36:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GarrettPetersen",
"github_project": "svgsimplegraph",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "svgsimplegraph"
}
JSON
