# Magazine
Let your code take comprehensive notes and publish notes and figures as a beautiful consolidated PDF document.
## Idea
The magazine package helps you to create beautiful PDF reports of what has been done during the execution of your app.
1. Your scripts or submodules can write *Stories* in plain human-readable text, which could also include numerical results or figures, for instance.
2. The collection of stories can be used to *Publish* a glossy PDF document.
## Example
```python
from magazine import Story, Publish
E = 42
Story.report("Experiment", "The analysis found that energy equals {} Joule.", E)
Story.cite("10.1002/andp.19163540702")
with Publish("Report.pdf", "My physics report", info="Version 0.1") as M:
M.add_story("Experiment")
M.add_references()
```
- View the resulting magazine in [output/Report.pdf](https://github.com/mschroen/magazine/blob/main/output/Report.pdf).
- Check also `example.py` for more examples.
## Install
```bash
pip install magazine
```
Requires:
- fpdf2
- habanero (for academic citations)
- neatlogger (wrapper for loguru)
## Acknowledgements
- Uses the Google font [Roboto](https://fonts.google.com/specimen/Roboto) as it just looks great in PDFs.
Raw data
{
"_id": null,
"home_page": "https://github.com/mschroen/magazine",
"name": "Magazine",
"maintainer": null,
"docs_url": null,
"requires_python": ">3.9",
"maintainer_email": null,
"keywords": "logging, reports, pdf",
"author": "Martin Schr\u00f6n",
"author_email": "martin@schroen.eu",
"download_url": "https://files.pythonhosted.org/packages/9a/b8/75d2ba3ce83835165fa85bccca2c6367aab72ab3341d4d10328384b5cbfd/magazine-0.2.1.tar.gz",
"platform": null,
"description": "# Magazine\n\nLet your code take comprehensive notes and publish notes and figures as a beautiful consolidated PDF document.\n\n## Idea\n\nThe magazine package helps you to create beautiful PDF reports of what has been done during the execution of your app. \n1. Your scripts or submodules can write *Stories* in plain human-readable text, which could also include numerical results or figures, for instance. \n2. The collection of stories can be used to *Publish* a glossy PDF document.\n\n## Example\n\n```python\nfrom magazine import Story, Publish\n\nE = 42\nStory.report(\"Experiment\", \"The analysis found that energy equals {} Joule.\", E)\nStory.cite(\"10.1002/andp.19163540702\")\n\nwith Publish(\"Report.pdf\", \"My physics report\", info=\"Version 0.1\") as M:\n M.add_story(\"Experiment\")\n M.add_references()\n```\n\n- View the resulting magazine in [output/Report.pdf](https://github.com/mschroen/magazine/blob/main/output/Report.pdf).\n- Check also `example.py` for more examples.\n\n## Install\n\n```bash\npip install magazine\n```\n\nRequires:\n- fpdf2\n- habanero (for academic citations)\n- neatlogger (wrapper for loguru)\n\n## Acknowledgements\n\n- Uses the Google font [Roboto](https://fonts.google.com/specimen/Roboto) as it just looks great in PDFs.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Let your code take comprehensive notes and publish notes and figures as a beautiful consolidated PDF document.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/mschroen/magazine",
"Repository": "https://github.com/mschroen/magazine"
},
"split_keywords": [
"logging",
" reports",
" pdf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "870665dca0e2600a0ab49963d0c044a87f9728052a79411d35385defa20d80d6",
"md5": "54ef53c8cae561078f3f075f8123c6d4",
"sha256": "8cb3b53493173fcbbbfa178e8417eaa15947f21e8dbc986a0bb19d2d965b8096"
},
"downloads": -1,
"filename": "magazine-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54ef53c8cae561078f3f075f8123c6d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.9",
"size": 289974,
"upload_time": "2024-11-17T15:03:58",
"upload_time_iso_8601": "2024-11-17T15:03:58.199079Z",
"url": "https://files.pythonhosted.org/packages/87/06/65dca0e2600a0ab49963d0c044a87f9728052a79411d35385defa20d80d6/magazine-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ab875d2ba3ce83835165fa85bccca2c6367aab72ab3341d4d10328384b5cbfd",
"md5": "81c637ba4dc21a569a0fb1495ea0c5d3",
"sha256": "1cf70c5c426ad8a88ae921d19fc7eec523e1c921a672d9d17410f1aafb73c171"
},
"downloads": -1,
"filename": "magazine-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "81c637ba4dc21a569a0fb1495ea0c5d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.9",
"size": 288130,
"upload_time": "2024-11-17T15:04:00",
"upload_time_iso_8601": "2024-11-17T15:04:00.443265Z",
"url": "https://files.pythonhosted.org/packages/9a/b8/75d2ba3ce83835165fa85bccca2c6367aab72ab3341d4d10328384b5cbfd/magazine-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 15:04:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mschroen",
"github_project": "magazine",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "magazine"
}
JSON
