Package: py-simple-readme
py_simple_readme 0.0.8Quick, easy, navigatable readme generatorAboutInstallationUsageExamplereadme_generatorChangelog0.0.80.0.70.0.60.0.50.0.40.0.30.0.20.0.10.0.0About^I'm tired of hand-making big, navigatable readme.md files for github projects so I made this to make the process a lot less tedious. This readme was generated by this project.Installation^Available on pip -pip install py_simple_readmeUsage^Example^frompy_simple_readmeimportreadme_generator()gen=readme_generator(title="Example",slogan="This goes below the title in the readme")gen.set_changelog({"0.0.0":"Push"})gen.add_heading_1("About")gen.add_paragraph("A paragraph about the project.")gen.add_heading_1("Installation")gen.add_paragraph("Installation instructions")gen.add_heading_1("Usage")gen.add_paragraph("A paragraph about using the module")withopen("readme.md","w+")asf:f.write(gen.assemble())readme_generator^Simple object to handle the programatic generation of readme.md filesclassreadme_generator(object):def__init__(self,title:str=None,slogan:str=None,footnote_title:str='Notes:',footnote_heading_level:int=2,numbered_toc:bool=False,ignored:list=[]):...defadd_blockquote(self,text:str,end:str='\n\n'):"""Add a blockquoted paragraph at the current point in the readme body"""defadd_bold(self,text:str,end:str=''):"""Adds a bold piece of text at the current point in the readme body"""defadd_code_block(self,code:str,lang:str='python',end:str='\n'):"""Add a block of code at the current point in the readme body"""defadd_header_image(self,alt_text:str,url:str,replace_ok:bool=False):"""Adds an image to the images placed under the project title / slogan"""defadd_heading(self,text:str,level:int=1,end:str='\n',add_toc:bool=True):"""Add a heading, set "add_toc" keyword to add a table of contents entry. Set "end" keyword to change the line ending."""defadd_heading_1(self,text:str,**kwargs):"""Add a level 1 heading, set "add_toc" keyword to add a table of contents entry."""defadd_heading_2(self,text:str,**kwargs):"""Add a level 2 heading, set "add_toc" keyword to add a table of contents entry."""defadd_heading_3(self,text:str,**kwargs):"""Add a level 3 heading, set "add_toc" keyword to add a table of contents entry."""defadd_heading_4(self,text:str,**kwargs):"""Add a level 4 heading, set "add_toc" keyword to add a table of contents entry."""defadd_heading_5(self,text:str,**kwargs):"""Add a level 5 heading, set "add_toc" keyword to add a table of contents entry."""defadd_heading_6(self,text:str,**kwargs):"""Add a level 6 heading, set "add_toc" keyword to add a table of contents entry."""defadd_horizontal_rule(self):"""Adds a horizontal rule at the current point in the readme body"""defadd_italic(self,text:str,end:str=''):"""Adds italicized piece of text at the current point in the readme body"""defadd_link(self,link:str,text:str=None,tooltip:str=None):"""Adds a link at the current point in the readme body"""defadd_multi_blockquote(self,texts:list):"""Add multiple blockquoted paragraphs at the current point in the readme body"""defadd_ordered_list(self,texts:list,indent:int=0):"""Add an ordered (numbered) list as the current point in the readme body"""defadd_paragraph(self,text:str,end:str='\n\n'):"""Add a paragraph to the current point in the readme body"""defadd_toc(self,title:str,end:str='\n'):"""Add an entry to the table of contents at the current point in the readme body."""defadd_unordered_list(self,texts:list,indent:int=0):"""Add an unordered (non-numbered) list as the current point in the readme body"""defassemble(self):"""Generate the readme and return as a string."""defb(self,*args,**kwargs):"""Alias for add_bold"""defcb(self,*args,**kwargs):"""Alias for add_code_block"""defdd(self):"""Alias for decrease_toc_depth"""defdecrease_toc_depth(self):"""Decrease table of contents depth"""deffn(self,text:str):"""Alias for insert_footnote"""defget_prefix(self):"""Returns the appropriate blockquote depth indicator"""defh1(self,*args,**kwargs):"""Alias for add_heading_1"""defh2(self,*args,**kwargs):"""Alias for add_heading_2"""defh3(self,*args,**kwargs):"""Alias for add_heading_3"""defh4(self,*args,**kwargs):"""Alias for add_heading_4"""defh5(self,*args,**kwargs):"""Alias for add_heading_5"""defh6(self,*args,**kwargs):"""Alias for add_heading_6"""defhandle_class_list(self,classes:list,show_submodule:bool=False):"""Adds documentation for a list of classes at the current point in the readme body."""defhandle_function_list(self,functions:list,show_submodule:bool=False):"""Adds documentation for a list of functions at the current point in the readme body."""defhr(self):"""Alias for add_horizontal_rule"""defi(self,*args,**kwargs):"""Alias for add_italic"""defid(self):"""Alias for increase_toc_depth"""defincrease_toc_depth(self):"""Increase table of contents depth"""definsert_footnote(self,text:str):"""Inserts a footnote at the current point in the readme body."""defl(self,*args,**kwargs):"""Alias for add_link"""defol(self,*args,**kwargs):"""Alias for add_ordered_list"""defp(self,*args,**kwargs):"""Alias for add_paragraph"""defq(self,*args,**kwargs):"""Alias for add_blockquote"""defsave(self,path):"""Generate readme and save to a given location."""defset_changelog(self,changelog:dict):"""Set the changelog with a dictionary of version strings mapped to update info strings."""defset_header_images(self,images:dict,replace_ok:bool=False):"""Sets a list of header images from a dict that maps image_alt texts to image urls."""defset_slogan(self,slogan:str):"""Set readme slogan. This will appear directly below the readme title if set."""deftoc(self,*args,**kwargs):"""Alias for add_toc"""deful(self,*args,**kwargs):"""Alias for add_unordered_list"""Changelog^0.0.8^Fix issue with multiline comments, last push accidentally only fixed multi-line descriptions which needed the treatment too.0.0.7^Fix issue with multiline comments.0.0.6^Codeblocks can no longer be indented.0.0.5^Last patch didn't completely fix it0.0.4^Fix github codeblock incompatibility0.0.3^Add ignored methods to readme_generator keywords0.0.2^Add show_submodule argument to function/class documenter function0.0.1^Fix PyPi readme0.0.0^PushGenerated withpy_simple_readme