{
"info": {
"author": "Jean-Samuel Leboeuf",
"author_email": "jean-samuel.leboeuf.1@ulaval.ca",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3"
],
"description": "# Python2LaTeX: The Python to LaTeX converter\n\nDid you ever feel overwhelmed by the cumbersomeness of LaTeX to produce quality tables and figures? Fear no more, Python2LaTeX is here! Produce perfect tables automatically and easily, create figures and plots that integrates seamlessly into your tex file, or even write your complete article directly from Python! All that effortlessly (or almost) with Python2LaTeX.\n\n## Prerequisites\n\nThe package makes use of numpy and assumes a distribution of LaTeX that uses ``pdflatex`` is installed on your computer. Some LaTeX packages are used, such as ``booktabs``, ``tikz``, ``pgfplots`` and ``pgfplotstable``. Your LaTeX distribution should inform you if such package needs to be installed.\n\n## Installation\n\nTo install the package, simply run in your terminal the command\n\n pip install python2latex\n\n## Examples\n\n### Create a simple document\n\nThe following example shows how to create a document with a single section and some text.\n```python\nfrom python2latex import Document\n\ndoc = Document(filename='simple_document_example', filepath='./examples/simple document example', doc_type='article', options=('12pt',))\ndoc.set_margins(top='3cm', bottom='3cm', margins='2cm')\nsec = doc.new_section('Spam and Egg', label='spam_egg')\nsec.add_text('The Monty Python slays the Spam and eats the Egg.')\n\ntex = doc.build() # Builds to tex and compile to pdf\nprint(tex) # Prints the tex string that generated the pdf\n```\n\n\n\n Click to unfold result \n\n
\n\n
\n\n\n\n### Create a table from a numpy array\n\nThis example shows how to generate automatically a table from data taken directly from a numpy array. The module allows to add merged cells easily, to add rules where you want and even to highlight the best value automatically inside a specified area and more! To ease these operations, the the square brackets ('getitem') operator have been repurposed to select an area of the table instead of returning the actual values contained in the table. Once an area is selected, use the 'format_spec', 'add_rule', 'multicell', 'apply_command', 'highlight_best' or 'divide_cell' methods or properties. To get the actual values inside the table, one can use the 'data' attribute of the table. See the examples for extensive coverage of possibilities. Here is a simple, working example to give a preview of the usage.\n```python\nfrom python2latex import Document, Table\nimport numpy as np\n\n# Create the document of type standalone\ndoc = Document(filename='simple_table_from_numpy_array_example', filepath='examples/table examples', doc_type='standalone', border='10pt')\n\n# Create the data\ncol, row = 4, 4\ndata = np.random.rand(row, col)\n\n# Create the table and add it to the document at the same time\ntable = doc.new(Table(shape=(row+2, col+1), as_float_env=False)) # No float environment in standalone documents\n\n# Set entries with a slice directly from a numpy array!\ntable[2:,1:] = data\n\n# Set a columns title as a multicell with a simple slice assignment\ntable[0,1:] = 'Col title'\n# Set whole lines or columns in a single line with lists\ntable[1,1:] = [f'Col{i+1}' for i in range(col)]\ntable[2:,0] = [f'Row{i+1}' for i in range(row)]\n\n# Add rules where you want\ntable[1,1:].add_rule()\n\n# Automatically highlight the best value(s) inside the specified slice, ignoring text\nfor r in range(2,row+2):\n table[r].highlight_best('high', 'bold') # Best per row\n\ntex = doc.build()\nprint(tex)\n```\n_Result:_\n
\n\n
\n\n\n\n### Create a simple plot\nYou can plot curves as easily as with `matplotlib.pyplot.plot` with the `Plot` environement that compiles it directly into pdf! This is a wrapper around the `pgfplots` and `pgfplotstable` LaTeX packages.\n```python\nfrom python2latex import Document, Plot\nimport numpy as np\n\n# Document type 'standalone' will only show the plot, but does not support all tex environments.\nfilepath = './examples/plot examples/simple plot example/'\nfilename = 'simple_plot_example'\ndoc = Document(filename, doc_type='standalone', filepath=filepath)\n\n# Create the data\nX = np.linspace(0,2*np.pi,100)\nY1 = np.sin(X)\nY2 = np.cos(X)\n\n# Create a plot\nplot = doc.new(Plot(X, Y1, X, Y2, plot_path=filepath, as_float_env=False))\n\ntex = doc.build()\n```\n_Result:_\n
\n\n
\n\n\n\n### Create a more complex plot\nYou can make more complex plots with the options shown in this example.\n```python\nfrom python2latex import Document, Plot\nimport numpy as np\n\n# Create the document\nfilepath = './examples/plot examples/more complex plot example/'\nfilename = 'more_complex_plot_example'\ndoc = Document(filename, doc_type='article', filepath=filepath)\nsec = doc.new_section('More complex plot')\nsec.add_text('This section shows how to make a more complex plot integrated directly into a tex file.')\n\n# Create the data\nX = np.linspace(0,2*np.pi,100)\nY1 = np.sin(X)\nY2 = np.cos(X)\n\n# Create a plot\nplot = sec.new(Plot(plot_name=filename, plot_path=filepath))\nplot.caption = 'More complex plot'\n\nplot.add_plot(X, Y1, 'blue', 'dashed', legend='sine') # Add colors and legend to the plot\nplot.add_plot(X, Y2, 'orange', line_width='3pt', legend='cosine')\nplot.legend_position = 'south east' # Place the legend where you want\n\n# Add a label to each axis\nplot.x_label = 'Radians'\nplot.y_label = 'Projection'\n\n# Choose the limits of the axis\nplot.x_min = 0\nplot.y_min = -1\n\n# Choose the positions of the ticks on the axes\nplot.x_ticks = np.linspace(0,2*np.pi,5)\nplot.y_ticks = np.linspace(-1,1,9)\n# Choose the displayed text for the ticks\nplot.x_ticks_labels = r'0', r'$\\frac{\\pi}{2}$', r'$\\pi$', r'$\\frac{3\\pi}{2}$', r'$2\\pi$'\n\n# Use the tex environment 'axis' keyword options to use unimplemented features if needed.\nplot.axis.kwoptions['y tick label style'] = '{/pgf/number format/fixed zerofill}' # This makes all numbers with the same number of 0 (fills if necessary).\n\ntex = doc.build()\n```\n\n\n Click to unfold result \n\n
\n\n
\n\n\n### Create a simple matrix plot AKA heatmap\nYou can also make heatmaps in a similar fashion as a plot.\n```python\nfrom python2latex import Document, Plot\nimport numpy as np\n\n# Create the document\nfilepath = './examples/plot examples/simple matrix plot example'\nfilename = 'simple_matrix_plot_example'\ndoc = Document(filename, doc_type='standalone', filepath=filepath, border='1cm')\n\n# Create the data\nX = np.linspace(-3, 3, 11)\nY = np.linspace(-3, 3, 21)\n\n# Create a plot\nplot = doc.new(Plot(plot_name=filename, plot_path=filepath, as_float_env=False,\n grid=False, lines=False,\n enlargelimits='false',\n width=r'.5\\textwidth', height=r'.5\\textwidth'))\n\nXX, YY = np.meshgrid(X, Y)\nZ = np.exp(-(XX**2+YY**2)/6).T # Transpose is necessary because numpy puts the x dimension along columns and y dimension along rows, which is the opposite of a standard graph.\nplot.add_matrix_plot(X, Y, Z)\n\n# Adding titles and labels\nplot.x_label = 'X axis'\nplot.y_label = 'Y axis'\nplot.title = 'Some title'\n\ntex = doc.build()\n```\n_Result:_\n
\n\n
\n\nBe sure to check our more complex matrix plot example too!\n\n\n### Templating\nIf you do not want to write your whole document in python2latex, you can use our simple templating engine to insert parts of tex code directly inside your file.\nSimply write the command `%! python2latex-anchor = anchor_name_here` and the script will automatically insert the commands below it.\n\nSee our example folder for a simple usage example of the Template class.\n\n\n### Create an unsupported environment\nIf some environment is not currently supported, you can create one from the TexEnvironment base class.\n```python\nfrom python2latex import Document, TexEnvironment\n\ndoc = Document(filename='unsupported_env_example', doc_type='article', filepath='examples/unsupported env example', options=('12pt',))\n\nsec = doc.new_section('Unsupported env')\nsec.add_text(\"This section shows how to create unsupported env if needed.\")\n\nsec.add_package('amsmath') # Add needed packages in any TexEnvironment, at any level\nalign = sec.new(TexEnvironment('align', label='align_label'))\nalign.add_text(r\"\"\"e^{i\\pi} &= \\cos \\pi + i \\sin \\pi\\\\\n &= -1\"\"\") # Use raw strings to alleviate tex writing\n\ntex = doc.build()\nprint(tex)\n```\n\n\n Click to unfold result \n\n
\n\n
\n\n\n\n### Binding objects to environments\nTo alleviate syntax, it is possible to bind TexObject classes to an instance of a TexEnvironment. This creates an alternative class that automatically append any new instance of the class to the environment.\n```python\nfrom python2latex import Document, Section, Subsection, TexEnvironment\n\ndoc = Document(filename='binding_objects_to_environments_example', filepath='./examples/binding objects to environments example', doc_type='article', options=('12pt',))\nsection = doc.bind(Section) # section is now a new class that creates Section instances that are automatically appended to 'doc'\n\nsec1 = section('Section 1', label='sec1') # Equivalent to: sec1 = doc.new(Section('Section 1', label='sec1'))\nsec1.add_text(\"All sections created with ``section'' will be automatically appended to the document body!\")\n\nsubsection, texEnv = sec1.bind(Subsection, TexEnvironment) # 'bind' supports multiple classes in the same call\neq1 = texEnv('equation')\neq1.add_text(r'e^{i\\pi} = -1')\n\neq2 = texEnv('equation')\neq2 += r'\\sum_{n=1}^{\\infty} n = -\\frac{1}{12}' # The += operator calls is the same as 'add_text'\n\nsub1 = subsection('Subsection 1 of section 1')\nsub1 += 'Text of subsection 1 of section 1.'\n\nsec2 = section('Section 2', label='sec2')\nsec2 += \"sec2 is also appended to the document after sec1.\"\n\ntex = doc.build() # Builds to tex and compile to pdf\nprint(tex) # Prints the tex string that generated the pdf\n```\n\n\n Click to unfold result \n\n
![\"Simple](\"https://github.com/jsleb333/python2latex/blob/master/examples/simple%20document%20example/simple_document_example.jpg\")
\n![\"Table](\"https://github.com/jsleb333/python2latex/blob/master/examples/table%20examples/simple_table_from_numpy_array_example.jpg\")
\n![\"Simple](\"https://github.com/jsleb333/python2latex/blob/master/examples/plot%20examples/simple%20plot%20example/simple_plot_example.jpg\")
\n![\"More](\"https://github.com/jsleb333/python2latex/blob/master/examples/plot%20examples/more%20complex%20plot%20example/more_complex_plot_example.jpg\")
\n![\"Simple](\"https://github.com/jsleb333/python2latex/blob/master/examples/plot%20examples/simple%20matrix%20plot%20example/simple_matrix_plot_example.jpg\")
\n![\"Unsupported](\"https://github.com/jsleb333/python2latex/blob/master/examples/unsupported%20env%20example/unsupported_env_example.jpg\")
\n![\"Binding](\"https://github.com/jsleb333/python2latex/blob/master/examples/binding%20objects%20to%20environments%20example/binding_objects_to_environments_example.jpg\")
\n