markdown-worker

Name	markdown-worker JSON
Version	0.0.2 JSON
	download
home_page
Summary	A simple markdown parsing package.
upload_time	2023-07-27 06:11:00
maintainer
docs_url	None
author	Mantresh Khurana
requires_python
license
keywords	python mantresh khurana parser markdown
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            
# Markdown Worker

This is a simple markdown parser written in Python. It can read, write and parse markdown files. It can read a particular header, write a particular header, and parse a particular header. It can also parse the entire file.

## Installation

```bash
# use these commands to install the package source code to your local machine
git clone https://github.com/mantreshkhurana/markdown-worker-python.git
cd markdown-worker-python
```

or

```bash
pip install markdown-worker
```

or

```bash
pip3 install markdown-worker
```

## Usage

I provided a `example.md` file in the repository. You can use that to test the program, it contains all the [documentation](https://github.com/mantreshkhurana/markdown-worker-python/blob/stable/example.md) of the program.

```python
from markdown_worker import MarkdownParser

if __name__ == "__main__":
    file_name = input("Enter the path of the Markdown file: ")
    parser = MarkdownParser(file_name)

    heading_to_search = input("Enter the heading to search: ")

    result = parser.search_heading(heading_to_search)

    print("\nContent that was under this heading: \n")
    print(result)
```

## Author

- [Mantresh Khurana](https://github.com/mantreshkhurana)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "markdown-worker",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python,mantresh khurana,parser,markdown",
    "author": "Mantresh Khurana",
    "author_email": "<mantreshkhurana@spyxpo.com>",
    "download_url": "https://files.pythonhosted.org/packages/f3/67/46bfcf727598c1a3bac679aa4d481811e244dd0610b4cf21f8fdcf435c77/markdown_worker-0.0.2.tar.gz",
    "platform": null,
    "description": "\n# Markdown Worker\n\nThis is a simple markdown parser written in Python. It can read, write and parse markdown files. It can read a particular header, write a particular header, and parse a particular header. It can also parse the entire file.\n\n## Installation\n\n```bash\n# use these commands to install the package source code to your local machine\ngit clone https://github.com/mantreshkhurana/markdown-worker-python.git\ncd markdown-worker-python\n```\n\nor\n\n```bash\npip install markdown-worker\n```\n\nor\n\n```bash\npip3 install markdown-worker\n```\n\n## Usage\n\nI provided a `example.md` file in the repository. You can use that to test the program, it contains all the [documentation](https://github.com/mantreshkhurana/markdown-worker-python/blob/stable/example.md) of the program.\n\n```python\nfrom markdown_worker import MarkdownParser\n\nif __name__ == \"__main__\":\n    file_name = input(\"Enter the path of the Markdown file: \")\n    parser = MarkdownParser(file_name)\n\n    heading_to_search = input(\"Enter the heading to search: \")\n\n    result = parser.search_heading(heading_to_search)\n\n    print(\"\\nContent that was under this heading: \\n\")\n    print(result)\n```\n\n## Author\n\n- [Mantresh Khurana](https://github.com/mantreshkhurana)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A simple markdown parsing package.",
    "version": "0.0.2",
    "project_urls": null,
    "split_keywords": [
        "python",
        "mantresh khurana",
        "parser",
        "markdown"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf21db23e65c80819220d88250a484dc206daf91d184751f59a5302d18271cc3",
                "md5": "73a5cee30cebf768b1441a0eec21c781",
                "sha256": "821b9d3472b10a80a2077e6f1467379ad01ee6887043246b385e07db4d97592f"
            },
            "downloads": -1,
            "filename": "markdown_worker-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "73a5cee30cebf768b1441a0eec21c781",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4094,
            "upload_time": "2023-07-27T06:10:58",
            "upload_time_iso_8601": "2023-07-27T06:10:58.142303Z",
            "url": "https://files.pythonhosted.org/packages/bf/21/db23e65c80819220d88250a484dc206daf91d184751f59a5302d18271cc3/markdown_worker-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f36746bfcf727598c1a3bac679aa4d481811e244dd0610b4cf21f8fdcf435c77",
                "md5": "753db20f9b28460dc06726f159bce402",
                "sha256": "881361284df7cc6da9ab85ec99ce3a6c0180c999e24336c557a1472df0e42b43"
            },
            "downloads": -1,
            "filename": "markdown_worker-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "753db20f9b28460dc06726f159bce402",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3859,
            "upload_time": "2023-07-27T06:11:00",
            "upload_time_iso_8601": "2023-07-27T06:11:00.709790Z",
            "url": "https://files.pythonhosted.org/packages/f3/67/46bfcf727598c1a3bac679aa4d481811e244dd0610b4cf21f8fdcf435c77/markdown_worker-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-27 06:11:00",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "markdown-worker"
}