{ "info": { "author": "Awes Mubarak", "author_email": "awes.mubarak@awesmubarak.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: MIT License", "Programming Language :: Python" ], "description": "# Newpro\n\nA script to create boilerplates for text projects.\n\n## Introduction\n\nThis is a script I use to create boilerplates for writing projects in my\nworkflow. I doubt anyone else will benefit from this, but there's no harm in\nsharing anyway. My workflow involves writing in markdown, and generating a pdf\nand word document using [pandoc][]. I also use a biblatex bibliography\nsometimes. The generation is controlled by a Makefile.\n\n[pandoc]: https://pandoc.org/\n\n## Installation\n\nInstalling from PyPi (recommended):\n\n```bash\nsudo pip3 install newpro\n```\n\nInstalling from the working git repository:\n\n```bash\ngit clone https://github.com/awesmubarak/newpro\ncd newpro\nsudo python setup.py install\n```\n\nFull disclosure, I've only tested this on Linux. It _should_ also work on macOS\nand windows, but don't take my word for it.\n\n## Usage\n\nThe script is interactive, so there's no fancy magic required. This section\nwill walk through every section anyway.\n\n**Running the script**\n\nChange into the directory you want the project in and run `newpro`.\n\n**Author name**\n\nNormally, you'll be presented with a prompt for the author's name (typically\nyour own). The name will be converted to title case so capitalisation does not\nmatter. This step is tedious and can be skipped by creating a text file\nlocated at `~/.config/newpro.txt`. Enter only your name into this file. This\nwill skip the author prompt.\n\n**Project title**\n\nThis is the full title of your project. No explaining to do here.\n\n**Project name**\n\nThis is the name of your project. This should be a short identifier as it\nwill be used as the directory path and the base for all file names. For example\nif your set the name to `example`, the project will be located under the\n`example` subdirectory and contain the file `example.md`.\n\n**Bibliography**\n\nIf you choose to include a bibliography a bibtex file will be created. This\nincludes an example bibtex entry. For more information see this [biblatex\ntutorial][].\n\n[biblatex tutorial]: https://www.latex-tutorial.com/tutorials/bibtex/\n\n**License**\n\nI like using the [CC-BY-SA][] license in my work. This will temporary license\ntext at the bottom with a reminder to create a proper link with appropriate\nmetadata.\n\n[CC-BY-SA]: https://creativecommons.org/licenses/by-sa/4.0/\n\n## Example\n\nA typical run might look as follows:\n\n $ newpro\n Project title: Project title\n Project name: name\n Create a bibliography (y/N)? y\n Include CC-BY-SA license (y/N)? y\n\nCreating the following structure:\n\n $ tree\n .\n \u2514\u2500\u2500 name\n \u251c\u2500\u2500 Makefile\n \u251c\u2500\u2500 name.bib\n \u2514\u2500\u2500 name.md\n\n 1 directory, 3 files\n\n**Makefile**\n\n```Makefile\nname: name.md\n pandoc name.md --from markdown --output name.pdf --bibliography name.bib\n pandoc name.md --from markdown --to docx --output name.docx --bibliography name.bib\n```\n\n**name.bib**\n\n```bibtex\n/* @misc{ CHANGEME, */\n/* author = \"CHANGEME\", */\n/* title = \"CHANGEME\", */\n/* year = \"CHANGEME\", */\n/* publisher = \"CHANGEME\", */\n/* } */\n```\n\n**name.md**\n\n```markdown\n---\ntitle: Project title\ndate: 2017-12-09\nauthor: Awes Mubarak\n\n---\n\n-------------------------------------------------------------------------------\nThis work is licensed under a [Creative CommonsAttribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).\n\n```\n\nAll focus can then be directed to the markdown file (and bibliography if used).\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/awesmubarak/newpro", "keywords": "writing markdown pandoc", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "newpro", "package_url": "https://pypi.org/project/newpro/", "platform": "", "project_url": "https://pypi.org/project/newpro/", "project_urls": { "Homepage": "https://github.com/awesmubarak/newpro" }, "release_url": "https://pypi.org/project/newpro/1.0.1/", "requires_dist": null, "requires_python": "", "summary": "A script to create boilerplates for text projects.", "version": "1.0.1" }, "last_serial": 4275465, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "c7a34ec4896608d09a88b922c2693b1c", "sha256": "feb4c61d0d37dc071605fa0f72174adc409c6917efbe5c42db8ca54ce1b8de7c" }, "downloads": -1, "filename": "newpro-1.0.0-py2-none-any.whl", "has_sig": false, "md5_digest": "c7a34ec4896608d09a88b922c2693b1c", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6471, "upload_time": "2017-12-09T19:06:23", "url": "https://files.pythonhosted.org/packages/56/d2/49f55df94dae081f1e0737484219225f1ed0b987c49cd8492862fae882b8/newpro-1.0.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dcee7fbeaeae81504e5b5981a4f70e68", "sha256": "536cf28b2a0e591ea2288887f73200e7b71c2181dbee17259752f22b582d61de" }, "downloads": -1, "filename": "newpro-1.0.0.tar.gz", "has_sig": true, "md5_digest": "dcee7fbeaeae81504e5b5981a4f70e68", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4781, "upload_time": "2017-12-09T19:06:24", "url": "https://files.pythonhosted.org/packages/88/4e/6070c3351dfabc3788e89e34763802df2841bd782aeaf5d4b382dc582ce3/newpro-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "5c2fd1d7ce03418ac94163c58b356be9", "sha256": "98994fb8ce770ce20b22f8f4e918ce054c377f66bdb8b620d034293036f49d8e" }, "downloads": -1, "filename": "newpro-1.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "5c2fd1d7ce03418ac94163c58b356be9", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6650, "upload_time": "2018-09-15T19:54:13", "url": "https://files.pythonhosted.org/packages/8b/97/fe6bc67196a515e688897c66c58db4b70cff89fbfccbc529269bcf8408ae/newpro-1.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "74c894392ce30a66d23b547cec0d238a", "sha256": "37ff958ab5b7608cee81c2de0130e9ebb0ef33fca2172994e42dfaae0ba1fe9d" }, "downloads": -1, "filename": "newpro-1.0.1.tar.gz", "has_sig": true, "md5_digest": "74c894392ce30a66d23b547cec0d238a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4838, "upload_time": "2018-09-15T19:54:14", "url": "https://files.pythonhosted.org/packages/41/da/97a4e5ba3909021a7ea6ac959f8f64d34e2fffe0c5a6a0775c637e2a465f/newpro-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5c2fd1d7ce03418ac94163c58b356be9", "sha256": "98994fb8ce770ce20b22f8f4e918ce054c377f66bdb8b620d034293036f49d8e" }, "downloads": -1, "filename": "newpro-1.0.1-py2-none-any.whl", "has_sig": false, "md5_digest": "5c2fd1d7ce03418ac94163c58b356be9", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6650, "upload_time": "2018-09-15T19:54:13", "url": "https://files.pythonhosted.org/packages/8b/97/fe6bc67196a515e688897c66c58db4b70cff89fbfccbc529269bcf8408ae/newpro-1.0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "74c894392ce30a66d23b547cec0d238a", "sha256": "37ff958ab5b7608cee81c2de0130e9ebb0ef33fca2172994e42dfaae0ba1fe9d" }, "downloads": -1, "filename": "newpro-1.0.1.tar.gz", "has_sig": true, "md5_digest": "74c894392ce30a66d23b547cec0d238a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4838, "upload_time": "2018-09-15T19:54:14", "url": "https://files.pythonhosted.org/packages/41/da/97a4e5ba3909021a7ea6ac959f8f64d34e2fffe0c5a6a0775c637e2a465f/newpro-1.0.1.tar.gz" } ] }