enabled library usage

moved things around a bit to enable library usage

Author: k-dominik

README.md

@@ -14,7 +14,7 @@ conda install -c ilastik-forge -c conda-forge conda-3rdparty
 
 ## Usages
 
-### Basic
+### Command line usage:
 
 ```
 # generate text file with all licenses, sorted by package name
@@ -24,7 +24,7 @@ conda 3rdparty -n <environment_name> > 3rdparty.txt
 conda 3rdparty -n <environment_name> --check
 ```
 
-### supply missing licenses externally
+#### supply missing licenses externally
 
 ```
 conda 3rdparty -n <environment_name> --fallback-file <path-to-fallback.json>
@@ -33,6 +33,16 @@ conda 3rdparty -n <environment_name> --fallback-file <path-to-fallback.json>
 # dict["<package_name>"]["license_file"] = ["list_of_license", "files_relative_to_the_json_file"]
 ```
 
+### library usage
+
+```python
+from conda3rdparty import render_license_info
+from pathlib import Path
+
+license_texts = render_license_info(env_name="myenvname")
+# also takes `template_file: Path` and `fallback_file: Path` kwargs
+```
+
 
 ### jinja2 template support
 

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="conda-3rdparty",
-    version="0.0.2dev0",
+    version="0.0.3dev0",
     author="ilastik-team",
     license="MIT",
     license_files=("LICENSE",),

src/conda3rdparty/__init__.py

@@ -1 +1,3 @@
-__version__ = "0.0.2dev0"
+from .common import render_license_info
+
+__version__ = "0.0.3dev0"

src/conda3rdparty/cli.py

@@ -1,13 +1,10 @@
-import json
-import pathlib
 import sys
 from argparse import ArgumentParser
-from subprocess import check_output
-from typing import Iterable, Mapping, Union
+from pathlib import Path
 
 from conda3rdparty import __version__
 
-from .common import MISSING, CondaEnv, base_license_renderer
+from .common import MISSING, CondaEnv, load_fallback, render_license_info
 
 
 class CondaNotFound(Exception):
@@ -31,19 +28,11 @@ def parse_args():
     return args
 
 
-def load_fallback(fallback_path: pathlib.Path) -> dict:
-    assert fallback_path.exists()
-    fallback = json.loads(fallback_path.read_text())
-    for pkg in fallback:
-        fallback[pkg]["license_file"] = [
-            fallback_path.parent / license_file for license_file in fallback[pkg]["license_file"]
-        ]
-    return fallback
-
-
-def make_check(env: CondaEnv, fallback_file) -> int:
+def make_check(env_name: str, fallback_file: Path) -> int:
+    env = CondaEnv(env_name)
+    fallback_info = load_fallback(fallback_file) if fallback_file else None
     summary = []
-    for info in env.license_infos(fallback_file):
+    for info in env.license_infos(fallback_info):
         tmp = {"name": info["name"]}
         tmp.update(info["3rd_party_license_info"])
         tmp["ok"] = not any(x == MISSING for x in tmp["license_texts"])
@@ -60,19 +49,14 @@ def make_check(env: CondaEnv, fallback_file) -> int:
 
 def main():
     args = parse_args()
+    template = Path(args.template) if args.template else None
 
-    env = CondaEnv(args.name)
-
-    fallback = None
-    if args.fallback_file:
-        fallback = load_fallback(pathlib.Path(args.fallback_file))
+    fallback = Path(args.fallback_file) if args.fallback_file else None
 
     if args.check:
-        return make_check(env, fallback)
-
-    template = pathlib.Path(args.template) if args.template else None
+        return make_check(args.name, fallback)
 
-    print(base_license_renderer(env.license_infos(fallback), template_file=template))
+    print(render_license_info(args.name, template_file=template, fallback_file=fallback))
 
 
 if __name__ == "__main__":

src/conda3rdparty/common.py

@@ -65,6 +65,16 @@ def ensure_list(x):
     return package_info
 
 
+def load_fallback(fallback_path: Path) -> dict:
+    assert fallback_path.exists()
+    fallback = json.loads(fallback_path.read_text())
+    for pkg in fallback:
+        fallback[pkg]["license_file"] = [
+            fallback_path.parent / license_file for license_file in fallback[pkg]["license_file"]
+        ]
+    return fallback
+
+
 class CondaEnv:
     def __init__(self, env_name: str):
         self._name = env_name
@@ -110,9 +120,16 @@ def license_infos(self, fallback_info=None) -> List[Dict[str, Any]]:
 """
 
 
-def base_license_renderer(license_infos: List[Dict[str, Any]], template_file: Path = None):
+def base_license_renderer(license_infos: List[Dict[str, Any]], template_file: Path = None) -> str:
     if not template_file:
         template = Template(_base_template)
     else:
         template = Template(template_file.read_text())
     return template.render(license_infos=license_infos)
+
+
+def render_license_info(env_name: str, template_file: Path = None, fallback_file: Path = None) -> str:
+    env = CondaEnv(env_name)
+    fallback_info = load_fallback(fallback_file) if fallback_file else None
+    license_infos = env.license_infos(fallback_info=fallback_info)
+    return base_license_renderer(license_infos, template_file)