[WIP] pretty-print-network with md format

[Chetank99]

following up from: #1005
i have added a new function network_to_markdown(), that exports a network object's config to md format. It is using the current JSON-based network export format.

Added network_to_markdown() to hnn_io.py

I used this code to test it:

from hnn_core import jones_2009_model
from hnn_core.hnn_io import network_to_markdown

net = jones_2009_model(mesh_shape=(3, 3))

#if we dont want to save, we can remove file param and just print
md_text = network_to_markdown(net,'file.md') 
print(md_text)

Attaching a sample md file:
file.md

This is my first PR, so very open to feedback! If this is fine, I can work on making a table with differences of 2 network params

[jasmainak]

If this is a write_xxx function, it should follow the API in the remaining codebase

[jasmainak]

parameters should be documented in the docstring

[jasmainak]

top-level import

[jasmainak]

Suggested change

	md = []
	md = list()

hard to distinguish between [] and {} otherwise

[jasmainak]

can you add a test?

[Chetank99]

Hi @jasmainak ,
thank you for the review and comments, addressed them, except the test.

since it is a write_xxx function, used the syntax to have the overwrite param

documented via docstring

used list() for md

I am not sure right now how to add a test, going through hnn_core/tests to learn how the code base does it

[Chetank99]

@jasmainak I added a test into hnn_core/tests in the existing file, hnn_core/tests/test_io.py, called test_write_network_markdown

It is heavily inspired from test_write_configuration func in the same file. Do let me know if I should focus on any other aspect.

Thank you!

[jasmainak]

I will let @asoplata and @ntolley review the PR and merge if happy :)

[jasmainak]

you need to document this in api.rst

[Chetank99]

Thanks for the feedback! I have added it to the file!

[asoplata]

Hey @Chetank99 just to let you know, it may be a while before we have time to continue work on this. We've got "many irons in the fire".