\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{annaritz} \pdfinfo{ /Title (graphspace-python-client.pdf) /Creator (Cheatography) /Author (annaritz) /Subject (GraphSpace Python Client Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{5F73A3} \definecolor{LightBackground}{HTML}{F5F6F9} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{GraphSpace Python Client Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{annaritz} via \textcolor{DarkBackground}{\uline{cheatography.com/67574/cs/16994/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}annaritz \\ \uline{cheatography.com/annaritz} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 16th September, 2018.\\ Updated 16th September, 2018.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Import Statements}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{`from \seqsplit{graphspace\_python.api.client} import GraphSpace`} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`from \seqsplit{graphspace\_python.graphs.classes.gsgraph} import GSGraph`} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{`from \seqsplit{graphspace\_python.graphs.classes.gsgroup} import GSGroup`} \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{`from \seqsplit{graphspace\_python.graphs.classes.gslayout} import GSLayout`} \tn % Row Count 8 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.52 cm} x{4.48 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Create a Graph}} \tn % Row 0 \SetRowColor{LightBackground} `G = GSGraph()` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#module-graphspace\_python.graphs.classes.gsgraph"\}\}Create empty graph\{\{/link\}\} \tn % Row Count 8 (+ 8) % Row 1 \SetRowColor{white} \seqsplit{`G.add\_node('a')`} & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.add\_node"\}\}Add node to graph\{\{/link\}\} \tn % Row Count 17 (+ 9) % Row 2 \SetRowColor{LightBackground} `..., label='A', ...)` & Label to display \tn % Row Count 19 (+ 2) % Row 3 \SetRowColor{white} `..., popup='html text', ...)` & Popup text \tn % Row Count 21 (+ 2) % Row 4 \SetRowColor{LightBackground} `G.add\_edge('a', 'b')` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.add\_edge"\}\}Add undirected edge to graph\{\{/link\}\} \tn % Row Count 30 (+ 9) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{3.52 cm} x{4.48 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Create a Graph (cont)}} \tn % Row 5 \SetRowColor{LightBackground} `..., directed=True, ...)` & Directed edge \tn % Row Count 2 (+ 2) % Row 6 \SetRowColor{white} `..., popup='html text', ...)` & Popup text \tn % Row Count 4 (+ 2) % Row 7 \SetRowColor{LightBackground} `G.set\_name('My Sample Graph')` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.set\_name"\}\}Add name/title to graph\{\{/link\}\} \tn % Row Count 13 (+ 9) % Row 8 \SetRowColor{white} `G.set\_tags({[}'sample'{]})` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.set\_tags"\}\}Add tags to graph\{\{/link\}\} \tn % Row Count 22 (+ 9) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Add Node Style}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{`G.add\_node\_style('a'}, shape='ellipse')` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.ALLOWED\_NODE\_SHAPES"\}\}Node shape\{\{/link\}\} \tn % Row Count 10 (+ 10) % Row 1 \SetRowColor{white} `..., color='blue', ...)` & Node color \tn % Row Count 12 (+ 2) % Row 2 \SetRowColor{LightBackground} `..., color='\#A152B8', ...)` & \{\{link="https://htmlcolorcodes.com/color-picker/"\}\}HTML color\{\{/link\}\} \tn % Row Count 16 (+ 4) % Row 3 \SetRowColor{white} `..., bubble='blue', ...)` & Bubble style \tn % Row Count 18 (+ 2) % Row 4 \SetRowColor{LightBackground} `..., height=40, width=20, ...)` & Custom size \tn % Row Count 20 (+ 2) % Row 5 \SetRowColor{white} `..., style='dashed', ...)` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.ALLOWED\_NODE\_BORDER\_STYLES"\}\}Border style\{\{/link\}\} \tn % Row Count 30 (+ 10) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Add Node Style (cont)}} \tn % Row 6 \SetRowColor{LightBackground} `..., border\_color='red', ...)` & Border color \tn % Row Count 2 (+ 2) % Row 7 \SetRowColor{white} `..., border\_width=2, ...)` & Border width \tn % Row Count 4 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Arguments should be combined into one `add\_node\_style` command.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Add Edge Style}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{`G.add\_edge\_style('a'}, 'b', \seqsplit{edge\_style='dotted')`} & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.ALLOWED\_EDGE\_STYLES"\}\}Edge style\{\{/link\}\} \tn % Row Count 10 (+ 10) % Row 1 \SetRowColor{white} `..., directed=True, ...)` & Directed edge \tn % Row Count 12 (+ 2) % Row 2 \SetRowColor{LightBackground} `..., color='\#FF5733', ...)` & \{\{link="https://htmlcolorcodes.com/color-picker/"\}\}HTML color\{\{/link\}\} \tn % Row Count 16 (+ 4) % Row 3 \SetRowColor{white} `..., arrow\_shape='tee', ...)` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.ALLOWED\_ARROW\_SHAPES"\}\}Arrow shape\{\{/link\}\} \tn % Row Count 26 (+ 10) % Row 4 \SetRowColor{LightBackground} `..., width=4, ...)` & Edge width \tn % Row Count 27 (+ 1) % Row 5 \SetRowColor{white} `..., color='magenta', ...)` & Edge color \tn % Row Count 29 (+ 2) % Row 6 \SetRowColor{LightBackground} `..., \seqsplit{arrow\_fill='hollow'}, ...)` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgraph.GSGraph.ALLOWED\_ARROW\_FILL"\}\}Arrow fill\{\{/link\}\} \tn % Row Count 39 (+ 10) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Add Edge Style (cont)}} \tn % Row 7 \SetRowColor{LightBackground} `..., width=4, ...)` & Edge width \tn % Row Count 1 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Arguments should be combined into one `add\_edge\_style` command.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{3.76 cm} x{4.24 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Post Graph to GraphSpace}} \tn % Row 0 \SetRowColor{LightBackground} `gs = \seqsplit{GraphSpace('uname'}, 'psswd')` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.api.client.GraphSpace"\}\}Connect to GraphSpace\{\{/link\}\} \tn % Row Count 8 (+ 8) % Row 1 \SetRowColor{white} `graph = \seqsplit{gs.post\_graph(G)`} & Post (new) graph to GraphSpace \tn % Row Count 10 (+ 2) % Row 2 \SetRowColor{LightBackground} `graph = \seqsplit{gs.update\_graph(G)`} & Update (existing) graph to GraphSpace \tn % Row Count 12 (+ 2) % Row 3 \SetRowColor{white} \seqsplit{`gs.delete\_graph(graph=graph)`} & Delete graph from GraphSpace \tn % Row Count 14 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{Update Graph if it Exists, Otherwise Post it}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{def post(G, gs): \newline try: \newline graph = gs.update\_graph(G) \newline except: \newline graph = gs.post\_graph(G) \newline return graph} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Fetch Posted Graph}} \tn % Row 0 \SetRowColor{LightBackground} `graph = \seqsplit{gs.get\_graph(graph\_name='My} Sample Graph')` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.api.endpoint.graphs.Graphs.get\_graph"\}\}Fetch by graph name\{\{/link\}\} \tn % Row Count 9 (+ 9) % Row 1 \SetRowColor{white} `graph = \seqsplit{gs.get\_graph(graph\_id=12345)`} & Fetch by graph id \tn % Row Count 12 (+ 3) % Row 2 \SetRowColor{LightBackground} `graph.name` & Name of graph \tn % Row Count 13 (+ 1) % Row 3 \SetRowColor{white} `graph.id` & ID of graph \tn % Row Count 14 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{5.2 cm} x{2.8 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Make Graph Public}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{`gs.publish\_graph(graph=graph)`} & Make graph public \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \seqsplit{`gs.unpublish\_graph(graph=graph)`} & Make graph private \tn % Row Count 4 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Groups}} \tn % Row 0 \SetRowColor{LightBackground} `mygroup = GSGroup(name='My group', description='sample group')` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gsgroup.GSGroup"\}\}Create group\{\{/link\}\} \tn % Row Count 9 (+ 9) % Row 1 \SetRowColor{white} `group = \seqsplit{gs.post\_group(mygroup)`} & Add group \tn % Row Count 11 (+ 2) % Row 2 \SetRowColor{LightBackground} `group = \seqsplit{gs.get\_group(group\_name='My} group')` & Fetch group \tn % Row Count 14 (+ 3) % Row 3 \SetRowColor{white} \seqsplit{`gs.share\_graph(graph=graph}, group\_name='My group')` & Share graph with group \tn % Row Count 17 (+ 3) % Row 4 \SetRowColor{LightBackground} \seqsplit{`gs.unshare\_graph(graph=graph}, group\_name='My group')` & Remove graph from group \tn % Row Count 20 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{x{4 cm} x{4 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{Layouts}} \tn % Row 0 \SetRowColor{LightBackground} `L = GSLayout()` & \{\{link="http://manual.graphspace.org/projects/graphspace-python/en/latest/reference/index.html\#graphspace\_python.graphs.classes.gslayout.GSLayout"\}\}New empty layout\{\{/link\}\} \tn % Row Count 9 (+ 9) % Row 1 \SetRowColor{white} \seqsplit{`L.set\_node\_position('a'}, y=38.5, x=67.3)` & Set x and y coords \tn % Row Count 12 (+ 3) % Row 2 \SetRowColor{LightBackground} \seqsplit{`L.add\_node\_style()`},`L.add\_edge\_style()` & Add styles in layout \tn % Row Count 15 (+ 3) % Row 3 \SetRowColor{white} `L.set\_name('My Sample Layout')` & Layout name \tn % Row Count 17 (+ 2) % Row 4 \SetRowColor{LightBackground} \seqsplit{`L.set\_is\_shared(1)`} & Visible to members who can see graph \tn % Row Count 19 (+ 2) % Row 5 \SetRowColor{white} `layout = \seqsplit{graphspace.post\_graph\_layout(L}, graph=graph)` & Post (new) layout \tn % Row Count 22 (+ 3) % Row 6 \SetRowColor{LightBackground} `layout = \seqsplit{graphspace.get\_graph\_layout(layout\_name='My} Sample Layout', graph=graph)` & Fetch layout \tn % Row Count 27 (+ 5) % Row 7 \SetRowColor{white} `layout1 = \seqsplit{graphspace.update\_graph\_layout(layout)`} & Update (existing) layout \tn % Row Count 30 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Graphs usually have manually-determined layouts from GraphSpace, which are saved through the user interface.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}