hhoeflin / mkreports Goto Github PK

Tables can get very large. In order to prevent huge tables being written to disk accidentially, we restrict the number of rows to print by default. A warning should be logged when this occurs. Setting to None should correspond to no restrictions.

Several example pages for the different supported types for images, tables etc

Allow for central content area to be wider

To improve README

• include gif or image
• concentrate on when to use mkreports
• less focus on vim

Add a simple argument parser where minimal things can be specified, like the location of where the page should be created.

The wrapped markdown classes should have appropriate help files attached.

When a new page is created, ensure that the resulting file has an extension of '.md' so that mkdocs recognizes it as a markdown file

In code blocks, it could be interesting to store the state of local variables.

Links and anchors in markdown should be supported

In ipython, currently code is shown in "tabbed" form. Should let users choose other layout options as well.

A page currently only allows for looking at absolute path, but relative path should also be available.

Add availability of a project root, e.g. when creating code objects; absolute filenames should still be possible but the exception and potentially trigger a warning.

Ipython plugin that automatically copies code and items written in ipython console into a markdown report. This is intended to make it easy to browse tables and images also in situations where one only has access to a console.

Currently when adding a page with a path like page("QC/something"), the page gets inserted under "Qc", so the second letter becomes lowercase.

Option in a context manager to include additional code items, such as functions or modules (?)

It is easy and fast to include source code file references as part of the analysis.

Instead of including the snippet of code that was tracked, could instead provide simple links to the included code files?

The markdown classes should be refactored. Instead of returning requirements, backmatter and core markdown separately, this should be given as a single return value for core and backmatter and as a classmethod for the requirements.

The core and backmatter markdown should certainly be returned as a single type instance. The reason is that otherwise, additional coordination needs to be done regarding saving of ids or the page_path where the object is supposed to be stored.

For the requirements, the reason is that the requirements only depend on the class, not individual instances.

Include support for more different image types, such as seaborn, altair etc.

When using mkreports with mkdocs serve, during creation of files, errors can occur in mkdocs. Then the server shuts down. Mkreports needs a better way to handle this.

Add a way to list all available markdown classes for a page.

Make the interface for links cleaner. Split external and internal links.

Make it possible that the context managers can be nested easily.

The parameters of the markdown classes are getting complicated as to what is provided by the page and what by the user. All page-related parameters should be encapsulated into a single parameter to be passed.

Currently tables can´t include things like images. As far as possible, nested markdown items inside tables should be enabled.

Add functionality and docs for images of different sizes

Make avaiable the yadfc for DataTable to enable column filtering for data filtering.

Support for ordered and unordered lists in markdown

Improved support for selecting which code to display. It should be possible to exclude certain pieces of code, especially the parts that are related to writings things out in markdown (this sort of doubles things).

There can be serialization errors for tables to_json. The 'default_handler' is by default not set. Suggest to set the 'str' function as the default handler to serialize tables.

Currently mkreports server raises errors infinitely when a project directory is not present. This should be checked and captured.

The md object 'Image' is not named well; 'Figure' would be a better term, as it is Matplotlib and derived ones; Image suggests any image should work, but PIL is also there as a separate object; this is very confusing

The ID for the tabulator table is not passed correctly; this can lead to issues when loading two tables that have identical content (e.g. are emtpy).

Include support for the tabulator tables

Should this be the standard rather than the automatic appending

Include support for markdown references.

Currently, there is no visual structuring of code as one section after the other gets added to the page. Some visual support to distinguish the different sections of a document would be helpful.

One option for this would be a context manager that is returned from the page upon adding. Then inside the context manager code, all append operations for a specific heading could be performed and this code would be added to the page when the context manager exits.

How to exactly implement: TBD

It should not be necessary to put in the store-path in a separate step.

when pickling a report or page, an infinite recursion occurs when it is reloaded.

Need support for

• adding regular markdown pages that are static
• merging with an existing mkdocs