microsoft
Add json
the proposed PR addresses somehow issue #34. Having not found a suitable python library, I added a JsonConverter class independent of the PlainTextConverter. in a nutshell :
- parse document with python json.load()
- converts nested dictionaries into objects starting with the filename (e.g. json_org_example2.menu.id for {menu :{id : ...}} in json_org_example2.json
- converts JSON arrays into md ordered lists since json arrays are ordered
- adds some MD formatting
- adds back tips around key/value to avoid markdown interpreters using them as keywords
hash test / pre-commit ran, Ok
tested against json.org examples. output available here : https://gist.github.com/Gad/4de412dabb73c6a20b0a098089226814
@microsoft-github-policy-service agree
Gilles Reyna
Le jeu. 26 déc. 2024 à 14:05, microsoft-github-policy-service[bot] < @.***> a écrit :
@Gad https://github.com/Gad please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
- (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.
- Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
- Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
- Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
- Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
- Licenses.
- Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
- Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
- Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
- Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
- Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
- Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
- Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
- Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.
— Reply to this email directly, view it on GitHub https://github.com/microsoft/markitdown/pull/219#issuecomment-2562684486, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAYXYYZK4CFXQEWUCRZ4G32HP5JVAVCNFSM6AAAAABUHGTSCKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNRSGY4DINBYGY . You are receiving this because you were mentioned.Message ID: @.***>
Hello @Gad
Thanks for pull request and gist really helpful. https://gist.github.com/Gad/4de412dabb73c6a20b0a098089226814
I like this recursive function def _json_traversal(self, d: Union[dict, list], level: int, prefix: str) -> str
The output currently look like below after converting to markdown:-
# lib.glossary
`lib.glossary.title:'example glossary'`
## lib.glossary.GlossDiv
`lib.glossary.GlossDiv.title:'S'`
### lib.glossary.GlossDiv.GlossList
#### lib.glossary.GlossDiv.GlossList.GlossEntry
`lib.glossary.GlossDiv.GlossList.GlossEntry.ID:'SGML'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.SortAs:'SGML'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.GlossTerm:'Standard Generalized Markup Language'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.Acronym:'SGML'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.Abbrev:'ISO 8879:1986'`
##### lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef
`lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.para:'A meta-markup language, used to create markup languages such as DocBook.'`
###### lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.GlossSeeAlso
---
0. `lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.GlossSeeAlso[0]:'GML'`
1. `lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.GlossSeeAlso[1]:'XML'`
---
`lib.glossary.GlossDiv.GlossList.GlossEntry.GlossSee:'markup'`
I think is is hard to read. Some space in between could be good like below for all :- What do you think?
# lib.glossary
`lib.glossary.title:'example glossary'`
## lib.glossary.GlossDiv
`lib.glossary.GlossDiv.title:'S'`
### lib.glossary.GlossDiv.GlossList
#### lib.glossary.GlossDiv.GlossList.GlossEntry
Why not like this? (human readable)
# Glossary
## Title: example glossary
### Section: S
#### GlossEntry
- **ID**: SGML
- **SortAs**: SGML
- **GlossTerm**: Standard Generalized Markup Language
- **Acronym**: SGML
- **Abbreviation**: ISO 8879:1986
##### GlossDef
- **Description**: A meta-markup language, used to create markup languages such as DocBook.
- **See Also**:
- GML
- XML
#### GlossSee
- Related Term: markup
OR This would also be good
lib
└── glossary
├── title: example glossary
└── GlossDiv
├── title: S
└── GlossList
└── GlossEntry
├── ID: SGML
├── SortAs: SGML
├── GlossTerm: Standard Generalized Markup Language
├── Acronym: SGML
├── Abbrev: ISO 8879:1986
├── GlossDef
│ ├── para: A meta-markup language, used to create markup languages such as DocBook.
│ └── GlossSeeAlso
│ ├── GML
│ └── XML
└── GlossSee: markup
Also, Test case is missing.
Thanks and Best Regards! Viddesh
Thank you for your feedback Viddesh,
Regarding your first comment, yes analyzing the mime type instead of or in addition to the file extension is possible for those files without .json extension (as long as your /etc/mime.types include the desired extensions, afaik).
Regarding your second comment, my understanding - correct me if I'm wrong - is that this is mainly the job of the markdown renderer. for example, the tree structure you suggest is up to the renderer - usually through a plugin -although the markdown syntax should be modified to facilitate it (e.g. the tree like plugins I found are based on markdown code being indented). Granted, one could generate such a structure programmatically and enclose it within three backticks. The result would surely be prettier but wouldn't it make this lib more difficult in its context ("for indexing, text analysis") ? I had a hard time settling for a syntax that is both useful for this purpose and readable after rendering. Best regards, Gad
Hello @Gad ,
Thanks for your reply.
If there is any plugin or a parser that would parse through the JSON and returns the tree structure that would be good to have. I think that after converting from JSON file to markdown file, It depends on the specific use case on what they want to do with the JSON markdown file that they have. For example they may create parser for specific key, value or do some data analysis for training a RAG model.
Yes, Rendering depends on which format the end user want as output. This parser that you created is nice. The markdown preview is also fine.
if you add a new line the output will not feel congested. Find below:-
line number 1244: _md += "%s %s.%s\n\n" % ("#" * level, prefix, str(key))
# lib.glossary
`lib.glossary.title:'example glossary'`
## lib.glossary.GlossDiv
`lib.glossary.GlossDiv.title:'S'`
### lib.glossary.GlossDiv.GlossList
#### lib.glossary.GlossDiv.GlossList.GlossEntry
`lib.glossary.GlossDiv.GlossList.GlossEntry.ID:'SGML'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.SortAs:'SGML'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.GlossTerm:'Standard Generalized Markup Language'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.Acronym:'SGML'`
`lib.glossary.GlossDiv.GlossList.GlossEntry.Abbrev:'ISO 8879:1986'`
##### lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef
`lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.para:'A meta-markup language, used to create markup languages such as DocBook.'`
###### lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.GlossSeeAlso
---
0. `lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.GlossSeeAlso[0]:'GML'`
1. `lib.glossary.GlossDiv.GlossList.GlossEntry.GlossDef.GlossSeeAlso[1]:'XML'`
---
`lib.glossary.GlossDiv.GlossList.GlossEntry.GlossSee:'markup'`
Regards! Viddesh
