{"id":21181616,"url":"https://github.com/utility-code/pygroff","last_synced_at":"2025-06-16T07:39:53.458Z","repository":{"id":91712980,"uuid":"362389089","full_name":"utility-code/pyGroff","owner":"utility-code","description":"laTEX is awesome but we are lazy -\u003e groff with markdown syntax and inline code execution","archived":false,"fork":false,"pushed_at":"2021-05-04T17:33:58.000Z","size":7757,"stargazers_count":28,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T08:35:05.865Z","etag":null,"topics":["groff","python","utility","wrapper"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/utility-code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-28T08:10:56.000Z","updated_at":"2023-04-24T17:42:43.000Z","dependencies_parsed_at":"2023-03-22T18:04:30.596Z","dependency_job_id":null,"html_url":"https://github.com/utility-code/pyGroff","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/utility-code/pyGroff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utility-code%2FpyGroff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utility-code%2FpyGroff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utility-code%2FpyGroff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utility-code%2FpyGroff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/utility-code","download_url":"https://codeload.github.com/utility-code/pyGroff/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utility-code%2FpyGroff/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260120067,"owners_count":22961653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["groff","python","utility","wrapper"],"created_at":"2024-11-20T17:51:41.162Z","updated_at":"2025-06-16T07:39:53.420Z","avatar_url":"https://github.com/utility-code.png","language":"Python","readme":"# pyGroff\n\n- A wrapper for groff using python to have a nicer syntax for groff documents\n- [DOCUMENTATION](https://subhadityamukherjee.github.io/pyGroff/)\n- Very similar to markdown. So if you know what that is. You will love this :)\n- We hate word -.-\n- Editing pdfs is a pain and please we are lazy\n- We love markdown. But we need pdfs and docx. So why not \n- LaTEX is amazing but it is tooo much work for small things.\n- Vim is love. What can we do without keyboard shortcuts ):\n\n## What can you do\n- Write in a text file\n- Get a cover page as well :)\n- Get a Table of contents. (Due to limitations : its only on the last page for now.)\n- Add code. And get execution results directly! Default is python. You can use any other language in your system\n- Easy tables (Aint nobody got time for complicated ones)\n- You can get a word document too (you do need libreoffice for it)\n- Get auto generated, beautifully formatted pdfs and docs instantly\n- Not cry because you moved an image and now your document is in hieroglyphics\n- (You can also write in groff syntax in the file. It will work as well. Just in case you need something extra)\n\n## Requirements\n- You need python of course.\n- For python dependencies, using pip install -r requirements.txt (Only PIL)\n- Almost every unix system has groff preinstalled.\n- If you want to convert to word, you need libreoffice.\n- If you want to get a table of contents you will need pdftk\n        - yay pdftk #arch\n        - sudo pacman -S pdftk #arch\n        - sudo apt install pdftk\n\n## Syntax\n- p runner.py -f \"demo.txt\" -o \"syntax.pdf\"  (most basic)\n- p runner.py -f \"demo.txt\" -o \"syntax.pdf\" -c True -n \"Subhaditya Mukherjee\" -t \"pyGroff\" (with cover page)\n- Please please look at arguments\n- By default, it is assumed that you have images. If you wish to disable it (for more speed), just use -i False\n- Check syntax.pdf and demo.txt for an example\n- Refer to syntax.pdf for new, easier syntax :)\n- This was also generated by the program hehe\n\n## Examples of langauge strings\n- python -c (default)\n- argument -l\n- R -e\n\n## FAQ\n- I dont like the cover page\n        - If you know a bit of groff (check the links below), you can use \"-d False\" and then edit whatever you want using groff itself.\n        - Then run \"groff -ms {infile} -Tpdf \u003e {outfile}\" replacing the infile and outfile respectively.\n\n## Contribution guidelines\n- Can I contribute?\n        - YES\n- What to do?\n        - Check todo.md\n- Restrictions?\n        - File an issue first, if it looks useful. Go for it\n- Spelling mistakes?\n        - I mean sure why not xD\n\n## References\n- [Markdown syntax](https://www.markdownguide.org/basic-syntax/)\n- [My groff tutorial](https://github.com/SubhadityaMukherjee/groffTutorial)\n- [More syntax](https://opensource.com/article/18/2/how-format-academic-papers-linux-groff-me)\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futility-code%2Fpygroff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futility-code%2Fpygroff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futility-code%2Fpygroff/lists"}