knknkn1162 / mdrec

python => markdown

MDRec : Markdown Recorder from python

MDRec creates markdown file easily from python object. You can also convert this to html file at once.

Installation

pip install mdrec

Example

Here is example code, output result and raw_file respectively.

Code

from mdrec import MDRec

save_file = "./out/test_txt.md"
# set markdown file. (You may also try not to set this option.)
r = MDRec(save_file=save_file)

# suppoort header. write "#### testtest\n\n" in designated save_file.
r.rec("testtest", h=4)

# plain txt
r.rec("this is example below")

# express itemization via Iterable object
r.rec([1,2,3])

# draw vertical line
r.line()

# support ja
r.rec(["あ", "い", "う", {"え" : "お"}])

# you should draw a vertical line explicitly
r.line()

# support nested list, dict or Iterable. 
r.rec([1,[1,2],[2,[3],4], [{"a": 100, "b": 234}], {"c" : [3,4,5]}])

## support quote
r.increase_quote_level()
## If you set raw option to be False, suppress markdown output in jupyter notebook.
r.rec("testtest", h=2, raw=False)

r.increase_quote_level()
r.rec(["z", 'x'])

r.reset_quote_level()

from pandas import DataFrame
# support DataFrame or Series ((NOT support list of list)
df = DataFrame([[12, 2, 4, 3], [3, 3, 3, 4]], columns=list("abcd"), index=["AB", "BB"])

# display table with title
r.rec(df, title="test", h=3)

# set link. support both url and local file path.
r.link(src="./test01.png", title="test", text="sample")

# image link with markdown syntax. To display image in jupyter notebook syncronously, set copy_sync=True
r.img(src="./test01.png", title="test", text="sample", copy_sync=True)

# export markdown file to html via github API. (You can set your username and password in ~/.grip/settings.py.)
r.to_html()

Output

<start>

testtest

this is example below

• 1
• 2
• 3

---

• あ
• い
• う
• え: お

---

• 1
• • 1
  • 2
• • 2
  • • 3
  • 4
• • a: 100 b: 234
• c:
  • 3
  • 4
  • 5

testtest

• z
• x

test

	a	b	c	d
AB	12	2	4	3
BB	3	3	3	4

sample

<end>

Raw

#### testtest

this is example below

- 1
- 2
- 3

---

- あ
- い
- う
- え: お

---

- 1
- - 1
  - 2
- - 2
  - - 3
  - 4
- - a: 100
    b: 234
- c:
  - 3
  - 4
  - 5

> ## testtest
> 
>> - z
>> - x
>> 
### test
|   |  a  |  b  |  c  |  d  |
|---|----:|----:|----:|----:|
|AB |   12|    2|    4|    3|
|BB |    3|    3|    3|    4|


[sample](../test01.png "test")

![sample](img/test01.png "test")

Usage

• By default, results are also displayed in jupyter notebook, so if you switch off the option, let r.rec(obj, raw=False).

Configuration

• If you use MDRec.to_html, note that this call Grip and github API implicitly. To set github username and password, see the link, https://github.com/joeyespo/grip#configuration.

mdrec's Issues

create recursive method of MDRec.enum.

motivation

• MDRec.enum method doesn't traverse element of argument recursively. So, implement recursive itemization or enumeration for nested list.

rename heading => header

Easy to understand header rather than heading

if save_file is None, link or img method would not work

if save_file is None, link or img method would not work.
I'll try to cope with this issue

modify MDRec.img method

Now MDRec.img is unstable, so modify this method.

support japanese word in component.enum method

Fix component.enum method to support japanese word

useless cached_file

want to fix https://github.com/knknkn1162/mdrec/blob/dev_seed/mdrec.py#L18

convert dict object to `$key : $value`

MDRec.rec allows dict to convert

`$key : $value`

or

<dl>
  <dt>key</dt>
  <dd>value</dd>
</dl>

add badge in readme.md

add pypi badge in readme.md

add quote argument in MDRec.rec

add quote argument in MDRec.rec.

TypeError if type of data argument of MDRec.rec is DataFrame due to h arg.

If h = None and type(data) is DataFrame in MDRec.rec, Raise TypeError Exception.

TypeError: unsupported operand type(s) for -: 'NoneType' and 'int'

create links

create links in MDRec class

When MDRec.img copys file, this behaves synchronously.

When MDRec.img copys file, this behaves synchronously because of shutil.copyfile.
To prevent this, try to use shutil.copyfileobj method directly.

Introduce logger in component & mdrec module

Introduce logger in component & mdrec module

separate generate-markdown logic & write-file logic

separate new_MDRec class and Components from MDRec.

not separate when component.enum is called in a row.

Punctuation is to be needed when component.enum is called in a row. I suggest to add split_line option in component.enum method.

not modify version. fix 0.1dev => 0.1

modify versions in setup.py

comprehensive test on component.link

Test component.link comprehensively in that

1. links

• check url link
• check link of local file with designated local markdown file.

2. images

• check images with file copy or not <= `copy = True/False'
• check images with file not found. <= `ignore = True/False'
• check images with designated local markdown file <= md_dir option

Resize image with MDRec.img method

Resizing image with MDRec.img method could be pretty good.
But markdown syntax doesn't support this...

rename argument, display_notebook => display_markdown in MDRec.rec

see

mdrec/mdrec.py

Line 30 in 7268f1e

def rec(self, data, *, h=None, title=None, display_notebook=True):

create horizontal line in markdown

create horizontal line

that is the below line👇

---

fix img & link around relative path

bugfix img & link method in component module around relative path.

bugfix MDRec.rec that stem from enum method

bug fix MDRec.rec abound component.enum method

MDRec :ModuleNotFoundError after `pip install mdrec`

After registering mdrec in PyPI and running pip install mdrec,

$ python
[GCC 4.2.1 Compatible Apple LLVM 8.1.0 (clang-802.0.42)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import MDRec
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'MDRec'

Maybe this is because python setup.py sdist is executed while not copying mdrec.py. see also #53.

twine upload dist/* error

while running twine upload dist/*, the problem occurs:

Uploading distributions to https://upload.pypi.org/legacy/
Uploading mdrec-0.1-py3-none-any.whl
HTTPError: 400 Client Error: classifiers: 'Framework:: IPython' is not a valid choice for this field for url: https://upload.pypi.org/legacy/

When data argument of MDRec.rec is str type, this method returns None object

https://github.com/knknkn1162/mdrec/blob/dev_seed/mdrec.py#L35

improve setup.py

setuptools.setup method exists test_suite and tests_require option.
see also http://setuptools.readthedocs.io/en/latest/setuptools.html#test-build-package-and-run-a-unittest-suite

rename export_html

rename export_html => to_html

refactor MDRec._save

MDRec.counter is redundant. We need only MDRec.refresh, if MDRec._save is refactored.