treejson-cli 1.0.0__tar.gz

treejson_cli-1.0.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: treejson-cli
+Version: 1.0.0
+Summary: It shows the nested directory structure in JSON or YAML.
+Author-email: masaniki <masaniki.software@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/masaniki/python-treejson-cli
+Project-URL: Document, https://github.com/masaniki/python-treejson-cli/blob/master/README.md
+Project-URL: Issues, https://github.com/masaniki/python-treejson-cli/issues
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Topic :: Terminals
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Natural Language :: English
+Classifier: Natural Language :: Japanese
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: PyYAML
+
+# Abstract
+It shows the nested directory structure in JSON or YAML.
+
+Japanse document is [here](docs/README_JP.md).
+
+# How to install
+`pip install treejson-cli`
+
+## Package Dependencies
+
+The following packages may not work properly if they are not installed:
+
+- [PyYAML](https://pypi.org/project/PyYAML/): Most popular YAML parser for Python.
+
+# How to run
+`treejson <directory>`
+
+The directory structure is compiled into JSON and output to standard output.
+
+## Options
+
+Detail document is [here](docs/formal_document.md).
+
+`[-h|--help]`
+
+Shows help message.
+
+`[-v|--version]`
+
+Shows version message.
+
+`[-y|--yaml]`
+
+Outputs as a YAML format.
+
+`[-a|-all]`
+
+Visits hidden file.
+
+`[-d|--depth] <depth>`
+
+Specifies the depth of tree oftraversal.
+
+If depth=0, it shows current directory.
+
+`[-f|--file] <output_file>`
+
+Outputs as a JSON or YAML file.
+
+## Examples
+- `treejson tests/sample`
+  ```
+  {'sample': [{'parent01': [{'child01_01': ['grandchild01.txt']}, {'child01_02': ['grandchild02.txt']}, 'child01_03.txt']}, {'parent02': [{'child02_01': ['grandchild02_01.txt']}]}]}
+  ```
+- `treejson tests/sample -f tests/output.json`
+
+  [tests/output.json](tests/output.json)
+
+- `treejson tests/sample -yf tests/output.yaml`
+
+  [tests/output.yaml](tests/output.yaml)

treejson_cli-1.0.0/README.md

@@ -0,0 +1,61 @@
+# Abstract
+It shows the nested directory structure in JSON or YAML.
+
+Japanse document is [here](docs/README_JP.md).
+
+# How to install
+`pip install treejson-cli`
+
+## Package Dependencies
+
+The following packages may not work properly if they are not installed:
+
+- [PyYAML](https://pypi.org/project/PyYAML/): Most popular YAML parser for Python.
+
+# How to run
+`treejson <directory>`
+
+The directory structure is compiled into JSON and output to standard output.
+
+## Options
+
+Detail document is [here](docs/formal_document.md).
+
+`[-h|--help]`
+
+Shows help message.
+
+`[-v|--version]`
+
+Shows version message.
+
+`[-y|--yaml]`
+
+Outputs as a YAML format.
+
+`[-a|-all]`
+
+Visits hidden file.
+
+`[-d|--depth] <depth>`
+
+Specifies the depth of tree oftraversal.
+
+If depth=0, it shows current directory.
+
+`[-f|--file] <output_file>`
+
+Outputs as a JSON or YAML file.
+
+## Examples
+- `treejson tests/sample`
+  ```
+  {'sample': [{'parent01': [{'child01_01': ['grandchild01.txt']}, {'child01_02': ['grandchild02.txt']}, 'child01_03.txt']}, {'parent02': [{'child02_01': ['grandchild02_01.txt']}]}]}
+  ```
+- `treejson tests/sample -f tests/output.json`
+
+  [tests/output.json](tests/output.json)
+
+- `treejson tests/sample -yf tests/output.yaml`
+
+  [tests/output.yaml](tests/output.yaml)

treejson_cli-1.0.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "treejson-cli"
+version = "1.0.0"
+authors = [
+  { name="masaniki", email="masaniki.software@gmail.com" },
+]
+description = "It shows the nested directory structure in JSON or YAML."
+dependencies = ["PyYAML"]
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 1 - Planning",
+    "Environment :: Console",
+    "Topic :: Terminals",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Natural Language :: English",
+    "Natural Language :: Japanese"
+]
+license = "MIT"
+license-files = ["LICENCSE.txt"]
+
+[project.scripts]
+treejson = "main:mainCLI"
+
+[project.urls]
+Repository = "https://github.com/masaniki/python-treejson-cli"
+Document = "https://github.com/masaniki/python-treejson-cli/blob/master/README.md"
+Issues = "https://github.com/masaniki/python-treejson-cli/issues"

treejson_cli-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

treejson_cli-1.0.0/src/main.py

@@ -0,0 +1,100 @@
+import sys
+from pathlib import Path
+import argparse
+import yaml
+import json
+
+VERSION="v1.0.0"
+
+def mainCLI():
+    """
+    Smry: CLIを処理する関数。
+
+    Returns:
+        Type: dict
+        Smry: {directory名(str):[i(int):i番目の子directory名(str)]}という木構造。
+    """
+    parser=argparse.ArgumentParser(prog="PROG")
+    parser.add_argument("dirName",type=str,default=None,help="put in directory name. Both absolute and relative is OK.")
+    parser.add_argument("-v","--version",action="version",version=f"treejson {VERSION}")
+    parser.add_argument("-y","--yaml",action="store_true",help="output as a YAML format.")
+    parser.add_argument("-a","--all",action="store_true",help="visit hidden file.")
+    parser.add_argument("-f","--file",type=str,help="output as a file.")
+    parser.add_argument("-d","--depth",type=int,help="specify maximum depth.")
+    args=parser.parse_args()
+    dirname=Path(args.dirName)
+    outDict=directoryBFS(dirname.resolve(),maxDepth=args.depth,isAll=args.all)
+    if(args.yaml):
+        if(args.file is None):
+            yaml.safe_dump(outDict,sys.stdout)
+        else:
+            with open(args.file,mode="w",encoding="utf-8") as f:
+                yaml.safe_dump(outDict,f)
+    else:
+        if(args.file is None):
+            print(outDict)
+        else:
+            with open(args.file,mode="w",encoding="utf-8") as f:
+                json.dump(outDict,f)
+
+def directoryBFS(startDir:Path,maxDepth:int=None,isAll:bool=None):
+    """
+    Smry: directory構造を幅優先探索する関数。
+
+    Args:
+      startDir:
+        Type: Path.
+        Smry: 探索を開始するdirectory名。
+      maxDepth:
+        Type: Int.
+        Smry: 探索の最大の深さ。
+        Expl:
+        - current directoryは深さ0。
+        - 「maxDepth<現在の深さ」の時に探索打ち切り。
+        Default: 255.
+      isAll:
+        Type: Bool.
+        Smry: {True⇒隠しfileも探索, False⇒隠しfileを通過。}
+        Default: false.
+    Returns:
+      Type: dict
+      Smry: {directory名(str):[i(int):i番目の子directory名(str)]}という木構造。
+      Expl:
+      - {directory名(str):[i(int):i番目の子directory名|file名(str)]}。
+      - file名の時は、終端nodeになる。
+    """
+    if(maxDepth is None):
+        maxDepth=255
+    if(isAll is None):
+        isAll=False
+    outDict={startDir.name:[]}
+    visitQueue=[startDir]  #訪れるdirectory(Path型)を格納する。
+    listQueue=[outDict[startDir.name]]  #訪れるdirectoryの子要素のlist型を格納する。
+    depthQueue=[0]  #訪れるdiectoryの深さ(int型)を格納する。
+    while(True):
+        if(visitQueue==[]):
+            break
+        curDir=visitQueue.pop(0)
+        curList=listQueue.pop(0)
+        curDepth=depthQueue.pop(0)
+        nextDepth=curDepth+1
+        if(maxDepth<nextDepth):
+            continue
+        for childPath in curDir.iterdir():
+            childName=childPath.name
+            firstChr=childName[0]
+            if((not isAll) and firstChr=='.'):
+                continue
+            if(childPath.is_file()):
+                curList.append(childName)
+            else:
+                childDict={childName:[]}
+                curList.append(childDict)
+                visitQueue.append(childPath)
+                listQueue.append(childDict[childName])
+                depthQueue.append(nextDepth)
+    return outDict
+
+
+if(__name__=="__main__"):
+    mainCLI()

treejson_cli-1.0.0/src/treejson_cli.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: treejson-cli
+Version: 1.0.0
+Summary: It shows the nested directory structure in JSON or YAML.
+Author-email: masaniki <masaniki.software@gmail.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/masaniki/python-treejson-cli
+Project-URL: Document, https://github.com/masaniki/python-treejson-cli/blob/master/README.md
+Project-URL: Issues, https://github.com/masaniki/python-treejson-cli/issues
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Topic :: Terminals
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Natural Language :: English
+Classifier: Natural Language :: Japanese
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: PyYAML
+
+# Abstract
+It shows the nested directory structure in JSON or YAML.
+
+Japanse document is [here](docs/README_JP.md).
+
+# How to install
+`pip install treejson-cli`
+
+## Package Dependencies
+
+The following packages may not work properly if they are not installed:
+
+- [PyYAML](https://pypi.org/project/PyYAML/): Most popular YAML parser for Python.
+
+# How to run
+`treejson <directory>`
+
+The directory structure is compiled into JSON and output to standard output.
+
+## Options
+
+Detail document is [here](docs/formal_document.md).
+
+`[-h|--help]`
+
+Shows help message.
+
+`[-v|--version]`
+
+Shows version message.
+
+`[-y|--yaml]`
+
+Outputs as a YAML format.
+
+`[-a|-all]`
+
+Visits hidden file.
+
+`[-d|--depth] <depth>`
+
+Specifies the depth of tree oftraversal.
+
+If depth=0, it shows current directory.
+
+`[-f|--file] <output_file>`
+
+Outputs as a JSON or YAML file.
+
+## Examples
+- `treejson tests/sample`
+  ```
+  {'sample': [{'parent01': [{'child01_01': ['grandchild01.txt']}, {'child01_02': ['grandchild02.txt']}, 'child01_03.txt']}, {'parent02': [{'child02_01': ['grandchild02_01.txt']}]}]}
+  ```
+- `treejson tests/sample -f tests/output.json`
+
+  [tests/output.json](tests/output.json)
+
+- `treejson tests/sample -yf tests/output.yaml`
+
+  [tests/output.yaml](tests/output.yaml)

treejson_cli-1.0.0/src/treejson_cli.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/main.py
+src/treejson_cli.egg-info/PKG-INFO
+src/treejson_cli.egg-info/SOURCES.txt
+src/treejson_cli.egg-info/dependency_links.txt
+src/treejson_cli.egg-info/entry_points.txt
+src/treejson_cli.egg-info/requires.txt
+src/treejson_cli.egg-info/top_level.txt
+tests/test_dirjson.py

treejson_cli-1.0.0/src/treejson_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

treejson_cli-1.0.0/src/treejson_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+treejson = main:mainCLI

treejson_cli-1.0.0/src/treejson_cli.egg-info/requires.txt

@@ -0,0 +1 @@
+PyYAML

treejson_cli-1.0.0/src/treejson_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+main

treejson_cli-1.0.0/tests/test_dirjson.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+import json
+
+if(__name__=="__main__"):
+    parentDirectory=Path(__file__).parent
+    outputFile=parentDirectory/"output.json"
+    expectedFile=parentDirectory/"expected.json"
+    with open(outputFile,mode="r",encoding="utf-8") as f:
+        outDict=json.load(f)
+    with open(expectedFile,mode="r",encoding="utf-8") as f:
+        expDict=json.load(f)
+    if(outDict==expDict):
+        assert True
+    else:
+        assert False