<p align="center">
<img src="https://github.com/shangcode/md2sheet/raw/main/docs/img/md2sheet-logo.svg"/>
</p>
<p align="center">
<a href="https://pypi.org/project/md2sheet/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/md2sheet"></a>
<a href="https://pypistats.org/packages/md2sheet"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dw/md2sheet"></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
</p>
<p align="center">
<a href="https://pypi.org/project/md2sheet/"><img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/md2sheet"></a>
<a href="https://md2sheet.slack.com/"><img alt="Static Badge" src="https://img.shields.io/badge/slack---?style=social&logo=slack"></a>
</p>
<p align="center">
<a href="https://github.com/shangcode/md2xlsx/actions/workflows/pylint.yml"><img src="https://github.com/shangcode/md2xlsx/actions/workflows/pylint.yml/badge.svg?branch=main"></a>
<a href="https://github.com/shangcode/md2sheet/actions/workflows/scorecard.yml"><img src="https://github.com/shangcode/md2sheet/actions/workflows/scorecard.yml/badge.svg?branch=main"></a>
<a href="https://securityscorecards.dev/viewer/?uri=github.com/shangcode/md2sheet"><img src="https://api.securityscorecards.dev/projects/github.com/shangcode/md2sheet/badge"></a>
</p>
Convert structed markdown content into sheet(XLSX).
## Is this for me?
If you want convert a markdown like this:
```md
# Comics
## Detective Comics (DC)
### Batman Family
#### Batman
...
#### Catwoman
...
## Marvel Comics
### Avengers
#### Iron Man
...
#### Captain America
...
```
into sheet like this:
|h1|h2|h3|h4|h5|
|--|--|--|--|--|
|Comics|Detective Comics (DC)|BatmanFamily|Batman|...|
|Comics|Detective Comics (DC)|BatmanFamily|Cat woman|...|
|Comics|Marvel Comics|Avengers|Iron Man|...|
|Comics|Marvel Comics|Avengers|Captain America|...|
then you are on the right place.
đź’ˇFuthuremore, you can use office tools to modifiy the sheet according to your preferences:
## Requirements
Python 3.11+
The md2Sheet stands on the shoulders of giants:
- [markdown-to-json](https://github.com/njvack/markdown-to-json/)
- [OpenPyXL](https://openpyxl.readthedocs.io/en/stable/)
- [Typer](https://typer.tiangolo.com/)
## Installation
```console
pip install md2sheet
```
## Usage
```console
md2xlsx [OPTIONS] IN_FILE OUT_FILE
```
**Options**:
- `--install-completion`: Install completion for the current shell.
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
- `--help`: Show this message and exit.
**Arguments**:
- `IN_FILE`: Enter the markdown filepath [required]
- `OUT_FILE`: Enter the xlsx filepath [required]
## License
This project is licensed under the terms of the MIT license.
## Contract
<a href="https://md2sheet.slack.com"><img alt="Static Badge" src="https://img.shields.io/badge/slack---?style=for-the-badge&logo=slack"></a>
Raw data
{
"_id": null,
"home_page": "https://github.com/cybershang/md2sheet",
"name": "md2sheet",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "convert,structured,markdown,spreadsheet,csv,markdown_2_json,typer",
"author": "Yingjie Shang",
"author_email": "dev@yingjie.space",
"download_url": "https://files.pythonhosted.org/packages/31/af/d42c6f8873e5e88eecbcd38544a110ccf94af4ae409553931c8eec71a3ef/md2sheet-0.2.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n\n<img src=\"https://github.com/shangcode/md2sheet/raw/main/docs/img/md2sheet-logo.svg\"/>\n\n</p>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/md2sheet/\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/md2sheet\"></a>\n<a href=\"https://pypistats.org/packages/md2sheet\"><img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dw/md2sheet\"></a>\n<a href=\"https://opensource.org/licenses/MIT\"><img src=\"https://img.shields.io/badge/License-MIT-yellow.svg\"></a>\n</p>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/md2sheet/\"><img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/md2sheet\"></a>\n<a href=\"https://md2sheet.slack.com/\"><img alt=\"Static Badge\" src=\"https://img.shields.io/badge/slack---?style=social&logo=slack\"></a>\n</p>\n\n<p align=\"center\">\n<a href=\"https://github.com/shangcode/md2xlsx/actions/workflows/pylint.yml\"><img src=\"https://github.com/shangcode/md2xlsx/actions/workflows/pylint.yml/badge.svg?branch=main\"></a>\n<a href=\"https://github.com/shangcode/md2sheet/actions/workflows/scorecard.yml\"><img src=\"https://github.com/shangcode/md2sheet/actions/workflows/scorecard.yml/badge.svg?branch=main\"></a>\n<a href=\"https://securityscorecards.dev/viewer/?uri=github.com/shangcode/md2sheet\"><img src=\"https://api.securityscorecards.dev/projects/github.com/shangcode/md2sheet/badge\"></a>\n</p>\nConvert structed markdown content into sheet(XLSX).\n\n## Is this for me?\n\nIf you want convert a markdown like this:\n\n```md\n# Comics\n## Detective Comics (DC)\n### Batman Family\n#### Batman\n...\n#### Catwoman\n...\n\n## Marvel Comics\n### Avengers\n#### Iron Man\n...\n#### Captain America\n...\n```\n\ninto sheet like this:\n|h1|h2|h3|h4|h5|\n|--|--|--|--|--|\n|Comics|Detective Comics (DC)|BatmanFamily|Batman|...|\n|Comics|Detective Comics (DC)|BatmanFamily|Cat woman|...|\n|Comics|Marvel Comics|Avengers|Iron Man|...|\n|Comics|Marvel Comics|Avengers|Captain America|...|\n\nthen you are on the right place.\n\n\ud83d\udca1Futhuremore, you can use office tools to modifiy the sheet according to your preferences:\n\n\n## Requirements\nPython 3.11+\n\nThe md2Sheet stands on the shoulders of giants:\n\n- [markdown-to-json](https://github.com/njvack/markdown-to-json/)\n- [OpenPyXL](https://openpyxl.readthedocs.io/en/stable/)\n- [Typer](https://typer.tiangolo.com/)\n\n## Installation\n```console\npip install md2sheet\n```\n\n## Usage\n\n```console\nmd2xlsx [OPTIONS] IN_FILE OUT_FILE\n```\n\n**Options**:\n\n- `--install-completion`: Install completion for the current shell.\n- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.\n- `--help`: Show this message and exit.\n\n**Arguments**:\n\n- `IN_FILE`: Enter the markdown filepath [required]\n- `OUT_FILE`: Enter the xlsx filepath [required]\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n\n## Contract\n<a href=\"https://md2sheet.slack.com\"><img alt=\"Static Badge\" src=\"https://img.shields.io/badge/slack---?style=for-the-badge&logo=slack\"></a>\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A cli tool for convert markdown into sheet(xlsx).",
"version": "0.2.2",
"project_urls": {
"Homepage": "https://github.com/cybershang/md2sheet",
"Repository": "https://github.com/cybershang/md2sheet"
},
"split_keywords": [
"convert",
"structured",
"markdown",
"spreadsheet",
"csv",
"markdown_2_json",
"typer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "812fba7470343ffaa5af154233a662f352220ff54c939e9aafb119125438ee32",
"md5": "4f291286930cd1dcdea0a0a781ed71e5",
"sha256": "c7941b2344b6a38d11a234e80669abd3ae0b4a5216579e9690c454679112ef64"
},
"downloads": -1,
"filename": "md2sheet-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f291286930cd1dcdea0a0a781ed71e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 4625,
"upload_time": "2024-01-22T06:46:30",
"upload_time_iso_8601": "2024-01-22T06:46:30.481720Z",
"url": "https://files.pythonhosted.org/packages/81/2f/ba7470343ffaa5af154233a662f352220ff54c939e9aafb119125438ee32/md2sheet-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31afd42c6f8873e5e88eecbcd38544a110ccf94af4ae409553931c8eec71a3ef",
"md5": "6fa742d4c458fa34f3919240c843cf25",
"sha256": "5958dbf1ff8b0b45d86a76065a109740bb782642446e073628cc649718b43c2f"
},
"downloads": -1,
"filename": "md2sheet-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "6fa742d4c458fa34f3919240c843cf25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3898,
"upload_time": "2024-01-22T06:46:31",
"upload_time_iso_8601": "2024-01-22T06:46:31.479210Z",
"url": "https://files.pythonhosted.org/packages/31/af/d42c6f8873e5e88eecbcd38544a110ccf94af4ae409553931c8eec71a3ef/md2sheet-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-22 06:46:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cybershang",
"github_project": "md2sheet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "markdown-to-json",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "typer",
"specs": [
[
"==",
"0.9.0"
]
]
}
],
"lcname": "md2sheet"
}
JSON
