Package: newpro
# NewproA script to create boilerplates for text projects.## IntroductionThis is a script I use to create boilerplates for writing projects in myworkflow. I doubt anyone else will benefit from this, but there's no harm insharing anyway. My workflow involves writing in markdown, and generating a pdfand word document using [pandoc][]. I also use a biblatex bibliographysometimes. The generation is controlled by a Makefile.[pandoc]: https://pandoc.org/## InstallationInstalling from PyPi (recommended):```bashsudo pip3 install newpro```Installing from the working git repository:```bashgit clone https://github.com/awesmubarak/newprocd newprosudo python setup.py install```Full disclosure, I've only tested this on Linux. It _should_ also work on macOSand windows, but don't take my word for it.## UsageThe script is interactive, so there's no fancy magic required. This sectionwill walk through every section anyway.**Running the script**Change into the directory you want the project in and run `newpro`.**Author name**Normally, you'll be presented with a prompt for the author's name (typicallyyour own). The name will be converted to title case so capitalisation does notmatter. This step is tedious and can be skipped by creating a text filelocated at `~/.config/newpro.txt`. Enter only your name into this file. Thiswill skip the author prompt.**Project title**This is the full title of your project. No explaining to do here.**Project name**This is the name of your project. This should be a short identifier as itwill be used as the directory path and the base for all file names. For exampleif your set the name to `example`, the project will be located under the`example` subdirectory and contain the file `example.md`.**Bibliography**If you choose to include a bibliography a bibtex file will be created. Thisincludes an example bibtex entry. For more information see this [biblatextutorial][].[biblatex tutorial]: https://www.latex-tutorial.com/tutorials/bibtex/**License**I like using the [CC-BY-SA][] license in my work. This will temporary licensetext at the bottom with a reminder to create a proper link with appropriatemetadata.[CC-BY-SA]: https://creativecommons.org/licenses/by-sa/4.0/## ExampleA typical run might look as follows:$ newproProject title: Project titleProject name: nameCreate a bibliography (y/N)? yInclude CC-BY-SA license (y/N)? yCreating the following structure:$ tree.└── name├── Makefile├── name.bib└── name.md1 directory, 3 files**Makefile**```Makefilename: name.mdpandoc name.md --from markdown --output name.pdf --bibliography name.bibpandoc name.md --from markdown --to docx --output name.docx --bibliography name.bib```**name.bib**```bibtex/* @misc{ CHANGEME, *//*        author = "CHANGEME", *//*        title = "CHANGEME", *//*        year = "CHANGEME", *//*        publisher = "CHANGEME", *//* } */```**name.md**```markdown---title: Project titledate: 2017-12-09author: Awes Mubarak----------------------------------------------------------------------------------This work is licensed under a [Creative CommonsAttribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).<!-- TODO: see https://creativecommons.org/choose/ -->```All focus can then be directed to the markdown file (and bibliography if used).