Metadata-Version: 2.1
Name: lindworm
Version: 0.0.4
Summary: core tools covering folder content, markdown, GUI
Home-page: https://gitlab.com/wobweger/lindworm
Author: Walter Obweger
Author-email: walter.obweger@gmail.com
License: MIT
Project-URL: Documentation, https://gitlab.com/wobweger/lindworm
Description: # lindworm
        
        lindworm is a pure python package.
        
        ## Dependencies
        
        Python 3 is required
        use of anaconda recommended.
        
        packages used:
        
        + [pandas][pandas]
        + [pysimplegui][pysimplegui]
        + [wx][wx]
        
        ## features
        
        + [lindworm.pyGatherMD](#lindworm.pyGatherMD)
        + [lindworm.ldmStorageFolder](#lindworm.ldmStorageFolder)
        + [lindworm.ldmStorageFolderFrm](#lindworm.ldmStorageFolderFrm)
        
        ## install
        
        Package is published at [pypi](https://pypi.org/project/lindworm).
        
        ```shell
        pip install lindworm
        ```
        
        ```shell
        python setup.py install
        ```
        
        ## lindworm.pyGatherMD{#lindworm.pyGatherMD}
        
        python gather for markdown to simple pandoc
        
        [markdown][mdSyntax] is a great way to document your thoughts and code. 
        If small md fragments are supposed to be combined into a single document using
        [pandoc][pandoc_home], certain problems may show up:
        
        + keeping right order
        + images in sub folders
        + references
        + links to files in md are suddenly dead in doc
        
        ### usage{#lindworm.pyGatherMD.usage}
        
        analyse markdown file and generate one result markdown file
        
        ```shell
        lindworm.gather.md
        ```
        
        ### goal
        
        a python script shall read one md file, analyse it and walk through each md file link. 
        all found md files shall be compacted into a new single one.  
        all images links shall be copied into a single media folder.  
        suggested tree structure shall be flattened out.  
        links to other file types, determined by extension, shall be modified to repo links.
        
        ### requirements
        
        + python 3 implementation
        + CLI, command line interface
        + configuration xml
        + project language English
        + coding language English, sort of
        
        ## background
        
        FIXME
        
        ### markdown
        
        [markdown][mdSyntax] or simple md is available in a lot of state-of-the-art platform, a few format instruction allow you to structure
        information into readable look, with any overhead.
        it's text rendered into html.
        
        benefits:
        
        + easy to learn
        + easy to remember
        + lightweight
        + safe, no macros or anything that might invite an attack
        
        ### pandoc
        
        [pandoc][pandoc_home] is a flexible document converter. 
        see [manual][pandoc_man]  
        It can read and write:
        
        + markdown
        + html
        + odt
        + docx
        + tex
        + pdf
        + epub
        + and more
        
        more on github
        
        + [src][pandoc_github]
        + [wiki][pandoc_wiki]
        + [tricks][pandoc_tricks]
        
        ## lindworm.ldmStorageFolder{#lindworm.ldmStorageFolder}
        
        Walk through folder content, gather filenames and directories,
        calculate fingerprint (SHA) on portions of data or all.
        Result can be stored in json file.
        
        ## lindworm.ldmStorageFolderFrm{#lindworm.ldmStorageFolderFrm}
        
        Provide GUI to increase usability of [lindworm.ldmStorageFolder](#lindworm.ldmStorageFolder).
        
        
        ## contribute
        
        every contribution is very much appreciated.  
        join, discuss, use and share.
        
        
        [mdSyntax]: https://sourceforge.net/p/scintilla/wiki/markdown_syntax/
        
        [pandas]: https://pandas.pydata.org/
        
        [pysimplegui]: https://pypi.org/project/PySimpleGUI/
        
        [wx]: https://wxPython.org/
        [wx_man]: https://docs.wxpython.org/
        
        [pandoc_home]: https://pandoc.org/index.html
        [pandoc_man]: https://pandoc.org/MANUAL.html
        [pandoc_github]: https://github.com/jgm/pandoc
        [pandoc_wiki]: https://github.com/jgm/pandoc/wiki
        [pandoc_tricks]: https://github.com/jgm/pandoc/wiki/Pandoc-Tricks
        
Keywords: tools
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications :: GTK
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
