Mkdocs-table-reader-plugin

Latest version: v3.1.0

Safety actively analyzes 682416 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 5

3.1.0

- Improved documentation on [Compatibility with mkdocs-macros-plugin](https://timvink.github.io/mkdocs-table-reader-plugin/howto/use_jinja2/)
- Added additional `pd_<reader_name>` macros (overview on the [readers](https://timvink.github.io/mkdocs-table-reader-plugin/readers/) page), available when `mkdocs-macros-plugin` is enabled. This enables new options like filtering tables, see the examples on the [compatibility with mkdocs-macros-plugin](https://timvink.github.io/mkdocs-table-reader-plugin/howto/use_jinja2/)

**Full Changelog**: https://github.com/timvink/mkdocs-table-reader-plugin/compare/v3.0.1...v3.1.0

3.0.1

What's Changed

* Add support for fixing indentation when using `mkdocs-macros-plugin` with indented content like tabs. See the [how to on using jinja2](https://timvink.github.io/mkdocs-table-reader-plugin/howto/use_jinja2/). by timvink in https://github.com/timvink/mkdocs-table-reader-plugin/pull/69


**Full Changelog**: https://github.com/timvink/mkdocs-table-reader-plugin/compare/v3.0.0...v3.0.1

3.0.0

What's Changed

- `table-reader` is now compatible with [`mkdocs-macros-plugin`](https://mkdocs-macros-plugin.readthedocs.io/en/latest/), which means you can [dynamically insert tables using jinja2 syntax](https://timvink.github.io/mkdocs-table-reader-plugin/howto/use_jinja2/).
- The `base_path` option has now been deprecated (and will log a warning when used). Now by default, the config_dir (path to your `mkdocs.yml` file) and docs_dir (path to your `docs/` dir) will always be searched when looking for a table file path
- The `search_page_directory` option has now been deprecated (and will log a warning when used). The markdown page's source file directory will always be searched when looking for a table file.

Breaking changes / upgrading guide

- Remove `base_path` and `search_page_directory` from your `mkdocs.yml` options.

diff
mkdocs.yml
plugins:
- - table-reader:
- base_path: docs_dir
- search_page_directory: True
+ - table-reader


- In your `mkdocs.yml` file, the `macros` plugin should be defined _before_ the `table-reader` plugin (previously this was after)

diff
mkdocs.yml
plugins:
- - table-reader
- - macros
+ - macros
+ - table-reader


**Full Changelog**: https://github.com/timvink/mkdocs-table-reader-plugin/compare/v2.2.2...v3.0.0

2.2.2

What's Changed

- Bugfix: reading tables with non-string headers now supported (63) by timvink in https://github.com/timvink/mkdocs-table-reader-plugin/commit/0b6201de52d5fcc96cce96386bfe936f90fdba44

**Full Changelog**: https://github.com/timvink/mkdocs-table-reader-plugin/compare/v2.2.1...v2.2.2

2.2.1

What's Changed

- Fixed edge case parsing keyword arguments that are tuples (62) by timvink in 404aa9660033b1081c45ebfb8e469ce129c16013

**Full Changelog**: https://github.com/timvink/mkdocs-table-reader-plugin/compare/v2.2.0...v2.2.1

2.2.0

What's Changed

* Create `schema.json` file to support auto-completion in IDEs by blakenetz in https://github.com/timvink/mkdocs-table-reader-plugin/pull/58
* Add codespell support (config, workflow to detect/not fix) and make it fix few typos by yarikoptic in https://github.com/timvink/mkdocs-table-reader-plugin/pull/59
* New args/kwargs string parsing, that now supports passing lists to arguments. Fixed by timvink in https://github.com/timvink/mkdocs-table-reader-plugin/commit/170e82c854a00aa74250e4114c6ab1b5fbadf292

The example below has an argument with a comma separated list, that would lead to an error before, but now works:

jinja2
{{ read_csv("file.csv", usecols=['A', 'B']) }}


New Contributors
* blakenetz made their first contribution in https://github.com/timvink/mkdocs-table-reader-plugin/pull/58
* yarikoptic made their first contribution in https://github.com/timvink/mkdocs-table-reader-plugin/pull/59

**Full Changelog**: https://github.com/timvink/mkdocs-table-reader-plugin/compare/v2.1.0...v2.2.0

Page 1 of 5

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.