S13-Words-for-the-Future-notebooks/reportlab-cheatsheet.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Reportlab Cheatsheet"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from reportlab.pdfgen.canvas import Canvas\n",
    "from reportlab.lib.pagesizes import letter, A4\n",
    "from reportlab.lib.units import inch, mm"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# ReportLab PDF Library\n",
    "\n",
    "![](data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxATDxAQEhMVFhIXFhAQGBIVFhAVFhUWFRYWFhUVFRYYHSggGBolHRUTITEiJSkrLi4uFx8zODMsNygtLisBCgoKBQUFDgUFDisZExkrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrK//AABEIALMBGQMBIgACEQEDEQH/xAAcAAEAAwADAQEAAAAAAAAAAAAABQYHAgMEAQj/xABEEAABAwICBgYGCAQFBQEAAAABAAIDBBEFIQYSMUFRkQcTYXGh0SIyUlOBkhQWF0JUYrHBFSOT4UOCwtLwM3KisuJj/8QAFAEBAAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/ANxREQEREBERAREQEREBEXTUzaoFkHcijXVr+zkus4g/s5IJZFDOxOTs5Lrdi0n5eX90E6irzsal/LyPmut2OTfl5HzQWVFVH6QzjczkfNdLtJ5/ycj5oLiipDtKqj/8+TvNdL9L6obo/ld/uQX1Fnb9Nasbovld/uXvwHTR0kgjma0X2ObcA/AnJBdUXwFfUBERAREQEREBERAREQEREBERAREQEREBERAUfiL8wOxSCh6593nkg8OJV0cMT5pXasbBrOdwHw71BR6aUDmhzZSQcwerlz/8Vx08OtSsg29dNDERxbfWcPBXOiwenbExvVMya0bBwQU12l1F7x39OXyXU7Suj9t39OXyV+/hcHumcgn8Lg90zkEGeu0opPbd/Tl8l1O0npfbd8knktH/AIXB7pnIJ/C4PdM5BBmT9I6Y/ed8knkuh+P03F3ySeS1T+Fwe6ZyCfwuD3TOQQZK7HKfi75JPJfYaxkgJZfLsI/ULWf4ZB7pnIKkaYxsFQGMaGhrBcAWzJP9kFZlHevG9tjcGxGa+49M9kD3R/8AUya2/tE2H6rlJHI0N6xpa+wJHfwQX/QnSQSNEEh9MbDxVyWDxzuY8PbcOGd1q+iWkDamIAn+YMiEFhREQEREBERAREQEREBERAREQEREBERAREQfCVXpn3JPaVO1T7McewqtucggMYHW4nh0G5pknP8A6j91pCz3AI+sxuZ+6KKOMdhIuf1WhICIiAiIgIiICzDSGo16qZ35i35cv2WnP2HuKx6t+kCR4+jyO9J3pC1jntF0HTUNabXF7EOHeNhXXWVDnm73FxGVyvrhU/hpfBdT2VG10L2t3uNrBB45VKaCPecSZG02GqXu55KPkCsPRRT61bVTbmhsY+A/ug1dERAREQEREBERAREQEREBERAREQEREBERB4cYktERxICrxKltIZPUb3lVvEajUhlk9lj3cgbIOfRo3XdW1PtzPAPY02H6K9Kq9GlKY8Nhvtdd57zmrUgIiICIiAiIgLjqDgFyRBx1BwCq/SHMG0gaNr3tHLM/orUqD0lVPpwR8A55+OQ/dBRpFeeiCmtSSTe8e4/C+Sz7EpdWKR3BpWvaA0fVYdTt36oPNBYUREBERAREQEREBERAREQeeorY2EB7gCc7FdYxSD2x4qr6T1N6ot9lrW88/wBwo51Q1rS5zg1ozLnEAAdpOxBehiUPtjxXfFM13quB7iqJT1LXtDmOa5p2Oa4EH4hc5JXNBcw2cMwe7cUF8RR2AYj19OyXedvepBzgNpQfUXwOB2FfUFZx+W81uAAVT0tmtSSN3vLIh/ncB5qQ0gxVzKiRvUyvz9ZjWlvMkKKEE1bNTxshkYxkgmkdIGtGq3ZaxOd0Gk4JT9XTQs4MaPBe5cGEWABGWS5oCIuJeOIQckREBEXFzwNpAQfSd6jDpDSe+b4+S7san1KaZ/Bjudslk7gg1ilxenkNmSNcdlhe6omn0HWVN4542ua0McH3NrZ2AA7V4+j2IvxKd/3YmNbbcCQSfjmFGYvPrzzP9p7zv2XsP0QddJo46eRsUlVDqEgu1QQbA3sLrZqOBrI2Mb6rQAO5YngsRkxGkiGy7nnuHHmtxAQfURcesbe1xfhcXQckREEfiuN01Nq9fK2PWvbWvnbbZR402wy4H0qPOw+9v+Czrpmqtatij9iK/wAXEn9LLOJgdg2ktA7yQEH6ogna8azSCOIXYobRSJsdHBGSNbUBIuL555hTKAiIgIi82I1HVwyyeyx7/lBKDNcQr9epnduMj7Z7gbD9FHY9TuqKcwDY90Yfnb0A4F3gFH01QCBfbt+O9e6GsZ1gjv6Wrr27AQL8ygm4Kemha2OmYWxhrRa1rkDM2XzEcRbFDLK82a1rnE/DZ3rytmFsiLrx6L6OVOIv6+vc1lNE8uFHHez3MJsZHbSLi9kE9oviMkVBDGMnuGu48NbOwXCuxSNlnTStbrHVBkeG6x4DWOZXDrMydm3IbuAUFi9ZhpqGtqNR07BrNDmSOLQd4sLbkFnZUOGbXEdoJU/gWOGRkrX/APUjBv25ZFUMaRUoy6y3ZqS+S9GC1ZfJUzR3MWoyPXsQC47RmgknTuJvc8yuHXOzGsbHaLldBkCh6GkrJ6uoldP1NNBYMhGr/Oy9Y5ZjPwQTnWEZgkdouFYtGce1mysmdnGLl3Fu4qqaxXio5z9IqQDkBE099r2/RBZMVx6SVxDXFke5oyJH5iokuPFcHPyJ25E2yz7FFaOUdYYDWVMw/muIZSgNHVt2jde6Cw0uLzQ+k1xIGZabkEDbbtUzpHivWU9M6NxAeXPyNvVFv9SrBdx2b15MJqS+lp+GoSO5xy8AEHvdO/23fM5ebEal2o+R7iSGudcknYLryY9XGGmllYLvAAYNt3uIazLvIUngfR5Vvp2Gpq3yOlAMjMtUNdta0W4cEEfR1MrqeHrHkksaXAk2JOezkuLj/wAuprSfCm08rQ0+iWgNZf1Q3K+e8/sq7iEupFI+/qtc7duCDiyvfHURNjOrr9YXkb2tG/wXF5PZ4L14Jo46HDfptTK6WokDWM1jkwOIuByXjc5BKdHNP1mKyP3RxhvxOZ/Za8sq6OK+npzUyVDxG57sgQ4ktGQOQPBXOr0so3QzdVM1zwxzgLOG7K1wgqGnWl0j5XU8DyyNpLXOaSHPdvFxsaFRRI4O1gXB3EEg812PcTmdpzPedq44RgtRV1TmtkbFBEzrHuOrd526uY2ZIOdZi9TI4OdLLewbk5w2dgK+4JiNT9MpmNlku9+rm95y35XXhkAue8qW0DgDsTjefViY+U/C5/ZB06f1PWYjUG9w0iIdzBZVpwzHYbjv4r310hfLJIfvOe7mSVywDAH1VRIXSthpoWGR7jYF5te2aCMMjg7WD3B23WBN+a1Lou0zle/6LO8vI2OdtI3X7Qssk32U1oEXfxKnaNpJ5CyD9IoiICrXSJWdVhtQb2L9SIf53Bp8LqyqL0jwZlXAYH2sSHXIvYjeO1BiFPUL1YRRulqKicf4MTW/A3cR4hXUdFcA2Sv5uVkwHRSClgkiYLukvrvdmXXyzQZzDUFT+hlbq1D4ifRkBI79h/ZeqTo3YST18gvuBcAO5SeAaFxU8nWF7pCNmsSbIKxVtMcr4ztBOXZuK8vUx9Z1uo3rLauvYXtwWg47o7FUZ+q/c4ZFVWXQGpJyqnAdzPJBAYzisEEfWS24NbYF73bmsG0lTkP0hmHw9e0Rvkd1nVC12Ntca3apXR/o7pIJRUS60842PlJdq/8AaDkF1adVH86NnstvzKCAfIAC4nIAknsG1fGTAtDhmDmCDcEcQozGprU8vEt1B3uy/dWDDNAnikgbDM6P0BlkbX7wUEPi2KxwROlk2DIN3vdua0byVJ6OaOzswx9RO21TM/6Q5u9rT6re8CymMC6OaeOZtTUOdUTNzZ1hu1h4tbsurq9oIIOw5WQZQJL718JVrxfQpr3F8LzGTnYbOWxQ/wBnE78pKyQM3hlmkjhdoBQU/FqmWokGG0fpVMvoPLdkER9d7zuNj49yn5aZkLjCz1Y7Qg8dQat+YKv2jOi1JQsLKeMNLvWkOb3n8ztqhcR0DbLK+Xrnt1iXarC4AXN9iCi4w3X
    "\n",
    "What is the ReportLab PDF Library?\n",
    "\n",
    "This is a software library that lets you directly create documents in Adobe's Portable Document Format (PDF)using the Python programming language. \n",
    "\n",
    "*tip*: the Reportlab Userguide, https://www.reportlab.com/docs/reportlab-userguide.pdf"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Canvas"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "Canvas?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Make a Canvas object, bottomup=0 will put the 0,0 at the lop-left (instead of bottom-left)\n",
    "c = Canvas(\"pdf/reportlab-cheatsheet.pdf\", pagesize=A4, bottomup=0)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Add a page\n",
    "c.showPage()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Save the PDF\n",
    "c.save()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Shapes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.circle?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.circle(20*mm, 20*mm, 10*mm, stroke=0, fill=1)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.rect?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.rect(40*mm, 40*mm, 10*mm, 10*mm, stroke=1, fill=0)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.roundRect?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.roundRect(60*mm, 60*mm, 50*mm, 50*mm, 5*mm, stroke=1, fill=0)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.showPage()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Fonts"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Reportlab comes with a set of fonts\n",
    "c.getAvailableFonts()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.setFont('Courier', 72)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Or you can import fonts\n",
    "from reportlab.pdfbase.ttfonts import TTFont, pdfmetrics\n",
    "\n",
    "fontpath = \"fonts/OSP-DIN.ttf\"\n",
    "font =  TTFont('OSP-DIN', fontpath)\n",
    "pdfmetrics.registerFont(font)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.setFont('OSP-DIN', 72)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.drawCentredString(105*mm, 50*mm, \"Hello :)!\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.showPage()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Colors"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Choose a RGB/CMYK color\n",
    "\n",
    "# Fill-color\n",
    "c.setFillColorRGB(255,0,0)\n",
    "c.setFillColorCMYK(0,1,0,0)\n",
    "\n",
    "# Stroke-color\n",
    "c.setStrokeColorRGB(255,255,0)\n",
    "c.setStrokeColorCMYK(0,0,1,0)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Or choose one of the embedded colors from Reportlab\n",
    "from reportlab.lib.colors import pink, magenta, red, blue\n",
    "\n",
    "c.setFillColor(magenta)\n",
    "c.setStrokeColor(red)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.setFont('OSP-DIN', 72)\n",
    "c.drawCentredString(105*mm, 50*mm, \"Hello :)!\")\n",
    "\n",
    "c.rect(105*mm, 150*mm, 50*mm, 50*mm, stroke=1, fill=1)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "c.showPage()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Lines"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Text"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Images"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}