{ "info": { "author": "Davide Sarra", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# NoTeX\n\nNoTeX is a CLI application to convert Markdown files into LaTeX-processed PDF\nfiles.\n\n## Installation\n\n```bash\npip install notex\n```\n\nNoTeX supports Python `3.6` and `3.7`, and requires\n[`pandoc`][pandoc_installation_guide].\n\n## Usage\n\nYou can generate a PDF for the markdown file `notes/machine_learning.md` with\nthe command below. The output is stored in `notes/machine_learning.pdf`.\n\n```bash\nnotex notes/machine_learning.md\n```\n\nThe title for the LaTeX PDF is taken from the first-level header (`# Header`)\nor the metadata. Metadata is optional and is declared at the top of the\nmarkdown file using pandoc-style yaml [metadata].\n\nFor example:\n\n```markdown\n---\nabstract: This is the abstract.\ntable-of-contents: true\n---\n\n# Title\n\nIntroduction.\n\n## Paragraph Header\n\nParagraph body.\n```\n\n## Philosophy\n\nWhen in 2004 John Gruber [created][md_wiki] the Markdown language, he\n[intended][original_md_syntax] the language to be used both to write and read\ncontent, with simplicity in mind.\n\nSince then Markdown has been extended, both in terms of syntax and of content.\nIn particular, [MathJax] allowed to type formulas thus making Markdown a more\nconvenient way to write scientific notes when the additional features of LaTeX\nwere not required.\n\nHowever, using (complex) formulas made reading Markdown files as they are\nwritten an overly inconvenient task. Sometimes, being able to render Markdown\nfiles into LaTeX-processed files can help strike a compromise between ease of\nwriting and ease of reading.\n\nMoreover, rendered files enable writers to share their formula-heavy content\nwith others who might not be familiar with the MathJax syntax.\n\nNoTeX was created to make writing and reading scientific Markdown files easy.\n\n## Implementation\n\nNoTeX is Python CLI application based on [pandoc], another CLI application to\nconvert between markup file formats, including Markdown and LaTeX. NoTeX\nnarrows down pandoc's scope so that using it becomes dead-simple, also adding\nsupport for LaTeX titles extracted from Markdown.\n\n## Development\n\nAfter cloning the repo, install the application including development\nrequirements.\n\n```bash\nmake install\n```\n\nAll Python code is formatted using `black` and linted using `flake8`.\n\n```bash\nmake format\n```\n\n```bash\nmake lint\n```\n\nBoth formatting and linting checks are performed within the test suite.\n\n```bash\nmake test\n```\n\n[MathJax]:https://www.mathjax.org/\n[md_wiki]:https://en.wikipedia.org/wiki/Markdown\n[metadata]:https://pandoc.org/MANUAL.html#metadata-variables\n[original_md_syntax]:https://daringfireball.net/projects/markdown/syntax\n[pandoc]:https://pandoc.org/\n[pandoc_installation_guide]:https://pandoc.org/installing.html\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/davidesarra/notex", "keywords": "markdown latex pdf python cli app", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "notex", "package_url": "https://pypi.org/project/notex/", "platform": "", "project_url": "https://pypi.org/project/notex/", "project_urls": { "Homepage": "https://github.com/davidesarra/notex" }, "release_url": "https://pypi.org/project/notex/0.0.3/", "requires_dist": [ "Click (==7.0)", "pypandoc (==1.4)", "black (==19.3b0) ; extra == 'dev'", "flake8 (==3.7.8) ; extra == 'dev'", "pytest (==5.1.3) ; extra == 'dev'", "pytest-mock (==1.10.4) ; extra == 'dev'" ], "requires_python": "~=3.6", "summary": "Turning markdown notes with formulas into LaTeX PDFs", "version": "0.0.3" }, "last_serial": 5931193, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "c67123629ea53fd6ec0b8eb988d12ddb", "sha256": "d7f3d41c4304875db547f5e51f27734537a8588e9dabd5c8c305d6a469c0843c" }, "downloads": -1, "filename": "notex-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "c67123629ea53fd6ec0b8eb988d12ddb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": "~=3.6", "size": 5860, "upload_time": "2019-10-01T19:16:25", "url": "https://files.pythonhosted.org/packages/01/6a/76492aabaf6102d7f96f59b6b2bea9d7902b54dc6d7c4836f150b0a28c0e/notex-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "55bbe2ae1d06cfcb934fe92c811081d2", "sha256": "3e329059e4f4803653750e8d65aa3ea251cd3d3fb2736901dfcb9b730e40e265" }, "downloads": -1, "filename": "notex-0.0.1.tar.gz", "has_sig": false, "md5_digest": "55bbe2ae1d06cfcb934fe92c811081d2", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.6", "size": 4595, "upload_time": "2019-10-01T19:16:29", "url": "https://files.pythonhosted.org/packages/aa/5e/b9f11d39ae7f7ad33bd6c575cfbad87665c0d32a0dabdedff132a3de6f79/notex-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "9bcff0107207a92f6b784d9a50d135c6", "sha256": "b2ea42555a43f354e5b72f4f9848d1a3ccc8c6f392d90772885c52b544ea78c9" }, "downloads": -1, "filename": "notex-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9bcff0107207a92f6b784d9a50d135c6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": "~=3.6", "size": 5678, "upload_time": "2019-10-02T11:59:30", "url": "https://files.pythonhosted.org/packages/1e/bb/ee15c8ac745ebcd0775c67f93be1d8d4b9bee8447d558ede83c50510fe1a/notex-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5882a6116bdd4c8598c2320ba9d55f12", "sha256": "19441b1abbf6e1f931b74d91d754f2216f70c191aedcff0469c598b06077d814" }, "downloads": -1, "filename": "notex-0.0.2.tar.gz", "has_sig": false, "md5_digest": "5882a6116bdd4c8598c2320ba9d55f12", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.6", "size": 4381, "upload_time": "2019-10-02T11:59:31", "url": "https://files.pythonhosted.org/packages/3a/02/8dddd99f932abfbcd80947c15c48a8a286370572535c856452c724f45b52/notex-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "6b8944cb983a5fd562af58fab3f53648", "sha256": "9b4784ac262c3f64a1ac83932e193d3fa581df897d836eeec083b7af7df08077" }, "downloads": -1, "filename": "notex-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "6b8944cb983a5fd562af58fab3f53648", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": "~=3.6", "size": 5787, "upload_time": "2019-10-05T06:28:36", "url": "https://files.pythonhosted.org/packages/5f/1f/3e8cc63ab323947c27ea4ddabc36d43f1993a549e356cd61ef614d9845dc/notex-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "922e642769f65963c40c9a8eb07bf0d2", "sha256": "e14640c4d8736d244732a80ff4c0214efd83537fd278d27be77f63c9d578d710" }, "downloads": -1, "filename": "notex-0.0.3.tar.gz", "has_sig": false, "md5_digest": "922e642769f65963c40c9a8eb07bf0d2", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.6", "size": 4452, "upload_time": "2019-10-05T06:28:38", "url": "https://files.pythonhosted.org/packages/e8/f8/35d121664f0071a87a5044a328e0fa112adc6a8f76270c696f169cc2e9e1/notex-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6b8944cb983a5fd562af58fab3f53648", "sha256": "9b4784ac262c3f64a1ac83932e193d3fa581df897d836eeec083b7af7df08077" }, "downloads": -1, "filename": "notex-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "6b8944cb983a5fd562af58fab3f53648", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": "~=3.6", "size": 5787, "upload_time": "2019-10-05T06:28:36", "url": "https://files.pythonhosted.org/packages/5f/1f/3e8cc63ab323947c27ea4ddabc36d43f1993a549e356cd61ef614d9845dc/notex-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "922e642769f65963c40c9a8eb07bf0d2", "sha256": "e14640c4d8736d244732a80ff4c0214efd83537fd278d27be77f63c9d578d710" }, "downloads": -1, "filename": "notex-0.0.3.tar.gz", "has_sig": false, "md5_digest": "922e642769f65963c40c9a8eb07bf0d2", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.6", "size": 4452, "upload_time": "2019-10-05T06:28:38", "url": "https://files.pythonhosted.org/packages/e8/f8/35d121664f0071a87a5044a328e0fa112adc6a8f76270c696f169cc2e9e1/notex-0.0.3.tar.gz" } ] }