diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 644d763..0e041c1 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/fossology.doctree b/.doctrees/fossology.doctree index 003b24d..0624a75 100644 Binary files a/.doctrees/fossology.doctree and b/.doctrees/fossology.doctree differ diff --git a/.doctrees/obj.doctree b/.doctrees/obj.doctree index c518a85..13626ce 100644 Binary files a/.doctrees/obj.doctree and b/.doctrees/obj.doctree differ diff --git a/.doctrees/uploads.doctree b/.doctrees/uploads.doctree index 1b181de..8e1b1f4 100644 Binary files a/.doctrees/uploads.doctree and b/.doctrees/uploads.doctree differ diff --git a/fossology.html b/fossology.html index 78ffa61..b39b2d6 100644 --- a/fossology.html +++ b/fossology.html @@ -116,7 +116,7 @@

Fossology
-class fossology.Fossology(url, token, name=None)
+class fossology.Fossology(url, token, version='v2')

Main Fossology API class

Authentication against a running Fossology instance is performed using an API token.

@@ -132,6 +132,7 @@

Fossology

  • url (str) – URL of the Fossology instance

  • token (str) – The API token generated using the Fossology UI

    • +

  • version (str) – the version of the API to use (default: “v2”)

Raises:
@@ -202,7 +203,7 @@

Fossology
-fossology.fossology_token(url, username, password, token_name, token_scope=TokenScope.READ, token_expire=None)
+fossology.fossology_token(url, username, password, token_name, token_scope=TokenScope.READ, token_expire=None, version='v2')

Generate an API token using username/password

API endpoint: POST /tokens

@@ -211,7 +212,7 @@

Fossology
>>> from fossology import fossology_token 
 >>> from fossology.obj import TokenScope 
->>> token = fossology_token("https://fossology.example.com", "Me", "MyPassword", "MyToken") 
+>>> token = fossology_token("https://fossology.example.com/repo", "Me", "MyPassword", "MyToken", version="v2")
@@ -223,6 +224,7 @@

FossologyTokenScope) – the scope of the token (default: TokenScope.READ)

  • expire (string) – the expire date of the token, e.g. 2019-12-25 (default: max. 30 days)

    • +

  • version (string) – the version of the API to use (default: “v2”)

    • Returns:
    diff --git a/obj.html b/obj.html index 566a8fb..dd7364d 100644 --- a/obj.html +++ b/obj.html @@ -579,7 +579,7 @@

    Fossology objects
    -class fossology.obj.Upload(folderid, foldername, id, description, uploadname, uploaddate, filesize=None, filesha1=None, hash=None, **kwargs)
    +class fossology.obj.Upload(folderid, foldername, id, description, uploadname, uploaddate, assignee=None, assigneeDate=None, closingDate=None, hash=None, **kwargs)

    FOSSology upload.

    Represents a FOSSology upload.

    @@ -591,6 +591,9 @@

    Fossology objectsHash) – the hash data of the uploaded file

  • kwargs (key word argument) – handle any other upload information provided by the fossology instance

    • diff --git a/searchindex.js b/searchindex.js index 2c8146b..b9bbc83 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["enums", "exceptions", "folders", "foss_cli", "fossology", "groups", "index", "items", "jobs", "license", "logging", "obj", "report", "sample_workflow", "uploads", "users"], "filenames": ["enums.rst", "exceptions.rst", "folders.rst", "foss_cli.rst", "fossology.rst", "groups.rst", "index.rst", "items.rst", "jobs.rst", "license.rst", "logging.rst", "obj.rst", "report.rst", "sample_workflow.rst", "uploads.rst", "users.rst"], "titles": ["Fossology Enums", "Fossology exceptions", "Fossology Folders", "Foss CLI", "Fossology", "Fossology Groups", "Welcome to fossology\u2019s documentation!", "Fossology Items", "Fossology Jobs", "Fossology License", "Logging", "Fossology objects", "Fossology Report", "Sample Workflow", "Fossology Uploads", "Fossology Users"], "terms": {"The": [0, 1, 2, 3, 4, 6, 8, 11, 12, 13, 14], "python": [0, 3, 6, 10, 11, 13, 14], "deriv": [0, 11], "from": [0, 4, 5, 6, 7, 9, 11, 12, 13, 14, 15], "rest": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "data": [0, 7, 8, 9, 11, 13, 14, 15], "class": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "accesslevel": [0, 3, 11, 13, 14, 15], "valu": [0, 3, 6, 11], "name": [0, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15], "none": [0, 1, 2, 3, 4, 7, 8, 9, 11, 12, 14, 15], "modul": [0, 1, 10], "qualnam": 0, "type": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "start": [0, 6, 11], "1": [0, 6, 8, 9, 11, 12, 14], "boundari": 0, "avail": [0, 3, 6, 7, 8, 13, 14], "access": [0, 2, 3, 5, 6, 7, 8, 9, 12, 13, 14, 15], "level": [0, 3, 5, 6, 11], "upload": [0, 3, 6, 7, 8, 11, 12], "privat": [0, 6], "protect": [0, 6, 14], "public": [0, 6, 9, 11, 13, 14, 15], "clearingscop": 0, "scope": [0, 4, 5, 6, 11], "clear": [0, 7, 11, 13, 14], "local": [0, 6, 13, 14], "packag": [0, 6, 8, 11, 13, 14, 15], "global": [0, 14], "clearingstatu": [0, 11, 14], "status": 0, "open": [0, 6, 9, 12, 13, 14], "inprogress": [0, 14], "close": [0, 14], "reject": [0, 14], "clearingtyp": 0, "to_be_discuss": 0, "irrelev": 0, "identifi": 0, "do_not_us": 0, "non_funct": 0, "copyrightstatu": [0, 7], "statu": [0, 7, 11, 14], "copyright": [0, 7, 11, 13, 14], "activ": [0, 9, 13], "inact": 0, "jobstatu": 0, "job": [0, 6, 11], "complet": [0, 6], "fail": [0, 2, 4, 5, 6, 7, 8, 9, 12, 14, 15], "queu": 0, "process": [0, 11], "licensetyp": [0, 9], "licens": [0, 7, 11, 13, 14], "candid": [0, 9, 11], "main": [0, 4, 6, 11], "all": [0, 2, 5, 6, 7, 8, 9, 12, 13, 14, 15], "memberperm": [0, 5], "group": [0, 2, 6, 8, 9, 11, 12, 14], "member": [0, 5, 11], "permiss": [0, 5, 11, 14], "user": [0, 2, 4, 5, 6, 8, 11, 13, 14], "admin": [0, 5, 6, 8, 11], "advisor": [0, 11], "obligationclass": 0, "classif": [0, 11], "an": [0, 4, 6, 7, 9, 13, 14], "oblig": [0, 9, 11], "green": 0, "white": 0, "yellow": 0, "red": [0, 9], "read_onli": 0, "read_writ": 0, "clearing_admin": 0, "prevnextselect": [0, 7], "file": [0, 6, 7, 11, 14], "select": [0, 7, 14], "prev": [0, 7, 11], "next": [0, 7, 11], "endpoint": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "withlicens": 0, "noclear": 0, "reportformat": [0, 3, 6, 12], "report": [0, 6], "format": [0, 3, 11, 12, 14], "dep5": [0, 6], "spdx2": [0, 6], "spdx2tv": 0, "readmeoss": [0, 6, 12], "unifiedreport": [0, 6], "searchtyp": 0, "item": [0, 11], "can": [0, 3, 6, 13], "search": [0, 11], "allfil": 0, "contain": [0, 6, 8, 14], "directori": [0, 6, 11], "tokenscop": [0, 4, 6, 13], "api": [0, 2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15], "token": [0, 3, 4, 6], "read": [0, 4, 6, 13], "onli": [0, 5, 6, 8, 9, 14], "limit": [0, 5, 8, 14], "get": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15], "call": [0, 2, 4, 5, 6, 7, 8, 9, 12, 13, 14, 15], "write": [0, 6, 12, 13], "requir": [0, 6, 14], "other": [0, 11, 14], "than": 0, "authenticationerror": [1, 4], "descript": [1, 2, 6, 11, 13, 14, 15], "respons": [1, 11], "authent": [1, 2, 4, 11], "error": [1, 4, 11], "authorizationerror": [1, 2, 7, 12, 14], "author": [1, 2, 7, 12, 14], "base": [1, 3, 6, 13], "thi": [1, 6, 9, 10, 13, 14], "fossologyapierror": [1, 2, 4, 5, 7, 8, 9, 12, 13, 14, 15], "dure": [1, 6], "request": [1, 2, 3, 4, 6, 7, 8, 9, 13, 15], "fossologyunsupport": [1, 3], "option": [1, 2, 3, 6, 7, 8, 9, 10], "support": [1, 6], "method": [2, 5, 6, 7, 8, 9, 11, 12, 14, 15], "us": [2, 3, 4, 5, 7, 8, 9, 10, 12, 13, 14, 15], "dedic": [2, 5, 7, 8, 9, 12, 14, 15], "relat": [2, 5, 6, 7, 8, 9, 12, 14, 15], "copy_fold": 2, "parent": [2, 11], "copi": [2, 14], "paramet": [2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15], "object": 2, "new": [2, 4, 6, 9, 14, 15], "return": [2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15], "updat": [2, 9, 14], "rais": [2, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15], "create_fold": [2, 6, 13], "str": [2, 3, 4, 5, 7, 8, 9, 11, 12, 14], "creat": [2, 3, 4, 5, 6, 8, 11, 15], "sub": [2, 11], "must": 2, "uniqu": [2, 11], "under": [2, 6], "same": 2, "ar": [2, 6, 7, 8, 9, 11, 13, 14], "case": [2, 6], "insensit": 2, "post": [2, 4, 5, 7, 8, 9, 14, 15], "id": [2, 5, 7, 8, 9, 11, 12, 13, 14, 15], "meaning": [2, 10], "default": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14], "string": [2, 4, 8, 11, 12, 14], "chosen": 2, "newli": 2, "alreadi": [2, 11, 13], "exist": [2, 13], "i": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14], "delete_fold": [2, 13], "delet": [2, 5, 14, 15], "detail_fold": 2, "folder_id": 2, "int": [2, 5, 7, 8, 9, 11, 12, 14, 15], "detail": [2, 4, 6, 8, 10, 13, 14, 15], "analyz": [2, 13], "list_fold": 2, "list": [2, 5, 6, 7, 8, 9, 11, 14, 15], "move_fold": 2, "move": [2, 14], "update_fold": 2, "": [2, 4, 10, 11, 15], "patch": [2, 6, 9, 14], "command": [3, 6], "foss_cli": [3, 6], "cmdline": 3, "interfac": [3, 6, 13], "provid": [3, 11], "commun": 3, "fossologi": [3, 10], "server": [3, 4, 6, 7, 11, 14], "log": [3, 6, 8, 13], "implement": [3, 6], "standard": [3, 10], "framework": 3, "adapt": 3, "v": [3, 6], "vv": [3, 6], "could": [3, 6, 13], "sent": 3, "consol": [3, 10], "log_to_fil": 3, "log_fil": 3, "log_file_nam": 3, "filenam": [3, 11, 13], "check_get_access_level": 3, "check": [3, 11], "given": [3, 5, 6, 8, 11, 12, 13, 14], "valid": 3, "enum": [3, 6, 13, 14], "check_get_fold": 3, "ctx": 3, "context": [3, 6], "folder_nam": [3, 6, 13], "folder": [3, 6, 7, 8, 11, 14], "instanc": [3, 4, 6, 11, 13, 15], "click": 3, "core": 3, "multipl": [3, 13], "time": [3, 7, 11, 12, 14], "found": [3, 4, 11], "check_get_report_format": 3, "get_newest_upload_of_fil": 3, "newest": [3, 6], "init_foss": 3, "initi": [3, 4, 6], "store": [3, 6, 13], "e": [3, 4, 6, 11, 13, 14], "keyerror": 3, "bearer": 3, "set": [3, 13], "environ": [3, 6, 13], "foss_inst": 3, "needs_later_initialization_of_foss_inst": 3, "later": 3, "indic": 3, "bool": [3, 5, 8, 9, 11, 14], "session": 4, "relev": [4, 13], "inform": [4, 6, 8, 11, 14], "url": [4, 6, 9, 11, 13, 14], "against": [4, 11], "run": [4, 6, 11], "perform": [4, 14], "exampl": [4, 6, 9, 12, 13, 14, 15], "import": [4, 6, 12, 14], "foss": [4, 6, 9, 12, 13, 14, 15], "foss_url": [4, 12, 14], "foss_token": [4, 12, 14], "gener": [4, 6, 9, 10, 12], "ui": [4, 13], "couldn": 4, "t": 4, "get_health": 4, "apiinfo": [4, 11], "health": [4, 11], "healthinfo": [4, 11], "get_info": 4, "info": [4, 7, 11], "get_self": 4, "first": [4, 8, 13], "popul": 4, "variabl": 4, "self": 4, "fossology_token": [4, 6, 13], "usernam": [4, 6, 11, 12, 13, 14], "password": [4, 6, 13, 15], "token_nam": [4, 6, 13], "token_scop": 4, "token_expir": 4, "obj": [4, 11, 13], "http": [4, 6, 9, 13, 14], "com": [4, 6, 13, 14, 15], "me": [4, 14], "mypassword": 4, "mytoken": 4, "expir": [4, 6], "date": [4, 11, 14], "g": [4, 6, 11, 13, 14], "2019": 4, "12": 4, "25": 4, "max": 4, "30": [4, 14], "dai": 4, "incorrect": 4, "anoth": [4, 12, 14], "occur": 4, "add_group_memb": 5, "group_id": 5, "user_id": [5, 15], "perm": [5, 11, 14], "add": [5, 6, 7, 9, 14], "create_group": [5, 6, 13], "delete_group": 5, "delete_group_memb": 5, "list_group_memb": 5, "usergroupmemb": [5, 11], "list_group": 5, "fals": [5, 7, 8, 9, 14], "If": [5, 6, 12, 14], "true": [5, 7, 8, 9, 13, 14, 15], "wether": [5, 14], "A": [6, 13, 15], "simpl": 6, "wrapper": 6, "see": [6, 13, 14], "openapi": 6, "specif": [6, 7, 8, 12, 14], "librari": 6, "current": [6, 11, 14], "releas": 6, "compat": 6, "version": [6, 11], "4": [6, 11], "0": [6, 8, 9, 11, 12, 13, 14, 15], "2": [6, 9, 11], "note": 6, "you": [6, 14], "miss": 6, "pleas": 6, "issu": 6, "pull": 6, "github": [6, 13, 14], "page": [6, 8, 9, 14], "project": 6, "pypi": 6, "org": [6, 9], "depend": 6, "pip": 6, "either": 6, "edit": [6, 14], "account": 6, "fossology_serv": [6, 13], "repo": [6, 13], "absens": 6, "trail": 6, "slash": 6, "otherwis": 6, "fossology_us": [6, 13], "fossi": [6, 13], "fossology_password": 6, "fossy_token": 6, "3": 6, "need": 6, "anymor": 6, "print": [6, 13], "f": [6, 13], "also": 6, "offer": 6, "line": 6, "simplifi": 6, "interact": 6, "your": [6, 13, 14], "To": [6, 10], "help": 6, "arg": 6, "configur": [6, 10, 11, 14], "config": 6, "enter": [6, 13], "within": 6, "ini": 6, "On": 6, "subsequ": [6, 13], "those": 6, "reus": [6, 8, 11, 13], "re": 6, "onc": 6, "verbos": 6, "increas": 6, "debug": [6, 10], "statement": 6, "foss_cli_result": 6, "fossgroup": 6, "fossfold": 6, "folder_group": 6, "folder_descript": 6, "upload_fil": [6, 13, 14], "zlib_1": 6, "11": 6, "dfsg": 6, "0ubuntu2": 6, "debian": 6, "tar": [6, 13], "xz": [6, 13], "access_level": [6, 13, 14], "sourc": [6, 13], "scan": [6, 7, 11], "workflow": 6, "includ": [6, 13], "start_workflow": 6, "file_nam": 6, "text": [6, 7, 9, 11, 13], "file_descript": 6, "dry_run": 6, "no_dry_run": 6, "do": [6, 13], "show": [6, 13, 14], "what": 6, "would": 6, "done": [6, 13], "output": 6, "reuse_newest_upload": 6, "no_reuse_newest_upload": 6, "reuse_newest_job": 6, "no_reuse_newest_job": 6, "schedul": [6, 7, 8, 11], "report_format": [6, 12], "spdxtv": 6, "messag": [6, 10, 13], "exit": 6, "form": 6, "bug": 6, "featur": 6, "merg": [6, 9], "proper": 6, "docstr": 6, "function": [6, 12, 14], "extend": 6, "testsuit": 6, "poetri": 6, "pytest": 6, "websit": 6, "automat": 6, "sphinx": 6, "autodoc": 6, "extens": 6, "hint": 6, "avoid": 6, "whole": 6, "branch": [6, 11], "chang": [6, 14], "touch": 6, "code": [6, 13], "feat": 6, "someth": 6, "test_foss_cli_": 6, "static": 6, "site": 6, "action": [6, 14], "everi": [6, 11], "push": 6, "gh": 6, "james": 6, "deploi": [6, 11], "b": 6, "html": [6, 13], "doc": 6, "cleanup": [6, 13], "rm": 6, "r": [6, 13], "dist": 6, "each": 6, "about": [6, 8, 10, 11, 14], "ad": [6, 7, 8, 9, 11, 13], "git": [6, 14], "vx": 6, "x": [6, 8], "m": 6, "major": 6, "minor": 6, "origin": 6, "correspond": [6, 13], "expect": 6, "hostnam": 6, "latest": 6, "docker": 6, "hub": 6, "xjf": 6, "files_11": [6, 13], "c": 6, "tmp": [6, 14], "mount": 6, "src": 6, "dst": 6, "bind": 6, "p": 6, "80": 6, "suit": 6, "coverag": 6, "get_bulk_histori": 7, "item_id": 7, "getbulkhistori": [7, 11], "bulk": [7, 11], "histori": [7, 11], "itemid": 7, "decis": [7, 11, 13, 14], "get_clearing_histori": 7, "getclearinghistori": [7, 11], "specifi": [7, 11, 12, 14], "get_prev_next": 7, "getprevnextitem": [7, 11], "index": 7, "previou": [7, 11], "tell": 7, "how": [7, 12, 14], "item_copyright": 7, "total": [7, 8, 11, 14], "mention": 7, "tree": [7, 11], "totalcopyright": 7, "number": [7, 8, 9, 11, 14], "uploadtre": 7, "item_info": 7, "fileinfo": [7, 11], "schedule_bulk_scan": 7, "spec": [7, 8], "dict": [7, 8, 11, 14, 15], "bodi": [7, 8, 9], "follow": [7, 8], "bulk_scan_spec": 7, "bulkact": 7, "licenseshortnam": 7, "mit": 7, "licensetext": 7, "acknowledg": 7, "comment": [7, 11, 14], "licenseact": 7, "remov": [7, 11], "reftext": 7, "refer": [7, 10, 11], "bulkscop": 7, "forcedecis": 7, "ignoreirr": 7, "delimit": 7, "scanonlyfind": 7, "detail_job": 8, "job_id": 8, "wait": [8, 12, 14], "timeout": 8, "10": [8, 12, 14], "boolean": [8, 9, 11, 14], "until": [8, 12, 14], "finish": 8, "stop": [8, 12, 14], "after": [8, 12, 13, 14], "second": [8, 12, 14], "list_job": 8, "page_s": [8, 9, 14], "100": [8, 9, 14], "all_pag": [8, 9, 14], "tupl": [8, 9, 12, 14], "answer": 8, "20": [8, 12, 14], "result": [8, 9, 11], "maximum": [8, 9], "per": [8, 9, 14], "retriev": [8, 9, 10], "schedule_job": [8, 13], "job_spec": 8, "analysi": [8, 13], "bucket": [8, 11, 13, 15], "copyright_email_author": [8, 11, 13, 15], "ecc": [8, 11, 13, 15], "keyword": [8, 11, 13, 15], "monk": [8, 11, 13, 14, 15], "mime": [8, 13, 15], "nomo": [8, 11, 13, 14, 15], "ojo": [8, 11, 13, 14, 15], "specific_ag": [8, 13], "decid": [8, 13], "nomos_monk": [8, 13], "bulk_reus": [8, 13], "new_scann": [8, 13], "ojo_decid": [8, 13], "reuse_upload": [8, 13], "reuse_group": [8, 13], "reuse_main": [8, 13], "reuse_enhanc": [8, 13], "reuse_report": [8, 13], "reuse_copyright": [8, 13], "which": [8, 11, 12, 14], "choos": [8, 12], "while": [8, 12, 14], "licenseendpoint": 9, "add_licens": 9, "merge_request": 9, "db": [9, 11], "here": 9, "new_licens": 9, "gpl": 9, "gnu": 9, "www": 9, "txt": 9, "detail_licens": 9, "shortnam": [9, 11], "short": [9, 11], "belong": [9, 14], "associ": [9, 11], "list_licens": 9, "kind": 9, "update_licens": 9, "fullnam": [9, 11], "risk": [9, 11], "snippet": 10, "logger": 10, "getlogg": 10, "streamhandl": 10, "setlevel": 10, "formatt": 10, "asctim": 10, "levelnam": 10, "setformatt": 10, "addhandl": 10, "offici": 10, "document": [10, 11], "further": [10, 11, 13], "possibl": [10, 13], "agent": [11, 13, 14, 15], "mimetyp": 11, "kwarg": 11, "repres": 11, "kei": 11, "word": 11, "argument": [11, 14], "handl": 11, "ani": 11, "to_dict": 11, "to_json": 11, "json": 11, "secur": 11, "contact": 11, "servic": 11, "addit": 11, "allow": 11, "email": [11, 15], "apilicens": 11, "fossologyserv": 11, "link": 11, "hash": 11, "find": [11, 13, 14], "filesearch": 11, "view_info": 11, "meta_info": 11, "package_info": 11, "tag_info": 11, "reuse_info": 11, "view": 11, "meta": 11, "tag": 11, "scanner": 11, "conclus": 11, "conclud": 11, "branchnam": 11, "commithash": 11, "commitd": 11, "builddat": 11, "commit": 11, "iso8601": 11, "were": 11, "built": 11, "bulkid": 11, "clearingeventid": 11, "match": [11, 14], "tri": 11, "addedlicens": 11, "iter": 11, "removedlicens": 11, "event": 11, "whether": 11, "who": 11, "previtemid": 11, "nextitemid": 11, "prevnext": 11, "sha1": 11, "md5": 11, "sha256": 11, "size": 11, "sum": 11, "mda": 11, "byte": 11, "overal": 11, "ok": 11, "warn": 11, "queuedat": 11, "uploadid": 11, "userid": 11, "groupid": 11, "eta": 11, "wo": 11, "estim": 11, "termin": 11, "iscandid": 11, "full": 11, "topic": 11, "attent": 11, "should": 11, "permgroup": 11, "group_pk": 11, "group_nam": [11, 13], "respect": [11, 14], "searchresult": 11, "uploadtreeid": 11, "where": 11, "ha": [11, 13], "been": [11, 13], "system": 11, "summari": [11, 14], "uploadnam": 11, "mainlicens": 11, "uniquelicens": 11, "totallicens": 11, "uniqueconcludedlicens": 11, "totalconcludedlicens": 11, "filestobeclear": 11, "filesclear": 11, "copyrightcount": 11, "remain": 11, "folderid": 11, "foldernam": 11, "uploadd": 11, "files": 11, "filesha1": 11, "uploadcopyright": 11, "filepath": 11, "rel": 11, "path": [11, 13, 14], "uploadlicens": [11, 14], "uploadpermgroup": 11, "publicperm": 11, "arrai": 11, "rootfolderid": [11, 15], "emailnotif": [11, 15], "default_group": 11, "tbd": 11, "root": 11, "notif": 11, "group_perm": 11, "structur": 11, "download_report": [12, 13], "report_id": [12, 13], "wait_tim": [12, 14], "download": [12, 13, 14], "readi": [12, 14], "look": [12, 14], "retri": [12, 14], "determin": [12, 14], "long": [12, 14], "period": [12, 14], "shall": [12, 14], "interv": [12, 14], "header": [12, 14], "try": [12, 13, 14], "attempt": [12, 14], "generate_report": [12, 13], "detail_upload": [12, 14], "up": [12, 14], "minut": [12, 14], "report_cont": 12, "report_nam": 12, "120": [12, 14], "wb": [12, 13], "report_fil": 12, "custom": [12, 13, 14], "instead": [12, 14], "content": [12, 13, 14], "tryagain": [12, 14], "out": [12, 14], "small": 13, "necessari": 13, "visibl": 13, "o": 13, "sy": 13, "pathlib": 13, "secret": 13, "getpass": 13, "except": 13, "fossology_user_pass": 13, "path_to_token_fil": 13, "cwd": 13, "pw": 13, "els": 13, "credenti": 13, "test": 13, "input": 13, "token_urlsaf": 13, "8": 13, "seen": 13, "databas": 13, "w": 13, "fp": 13, "len": 13, "load": 13, "awesomefossfold": 13, "folder_desc": 13, "awesomeprojectsourc": 13, "test_fold": 13, "rootfold": [13, 14], "restrict": 13, "resourc": 13, "io": 13, "Not": 13, "pass": [13, 14], "we": 13, "our": 13, "repositori": [13, 14], "my_bas": 13, "path_to_upload_fil": 13, "blob": 13, "master": [13, 14], "my_upload": [13, 14], "via": 13, "lib": 13, "archiv": [13, 14], "trigger": 13, "There": 13, "differ": 13, "export": 13, "control": 13, "furthermor": 13, "compon": 13, "step": 13, "best": 13, "explain": 13, "web": 13, "below": 13, "job_specif": 13, "resembl": 13, "button": 13, "detailed_job": 13, "disk": 13, "wa": 13, "written": 13, "unlink": 13, "change_upload_permiss": 14, "all_upload": 14, "new_permiss": 14, "public_permiss": 14, "put": 14, "want": 14, "delete_upload": 14, "chose": 14, "upload_id": 14, "long_upload": 14, "5": 14, "download_upload": 14, "its": 14, "list_upload": 14, "recurs": 14, "assigne": 14, "sinc": 14, "accord": 14, "filter": 14, "criteria": 14, "own": 14, "children": 14, "pattern": 14, "assign": 14, "unassign": 14, "yyyi": 14, "mm": 14, "dd": 14, "fetch": 14, "move_upload": 14, "destin": 14, "update_upload": 14, "state": 14, "ignor": 14, "empti": 14, "upload_copyright": 14, "gather": 14, "vc": 14, "apply_glob": 14, "ignore_scm": 14, "client": 14, "my": 14, "zip": 14, "product": 14, "vcstype": 14, "vcsurl": 14, "vcsname": 14, "vcsusernam": 14, "vcspassword": 14, "vcs_upload": 14, "accept": 14, "maxrecursiondepth": 14, "url_upload": 14, "server_upload": 14, "onlin": 14, "appli": 14, "scm": 14, "svn": 14, "tf": 14, "upload_licens": 14, "ninka": 14, "reportimport": 14, "expos": 14, "upload_permiss": 14, "upload_summari": 14, "list_uploads_paramet": 14, "helper": 14, "queri": 14, "create_us": 15, "user_spec": 15, "brand": 15, "defaultgroup": 15, "reso": 15, "heritag": 15, "defaultbucketpool": 15, "user_pass": 15, "defaultvis": 15, "creation": 15, "delete_us": 15, "detail_us": 15, "list_us": 15}, "objects": {"": [[4, 0, 0, "-", "fossology"]], "fossology": [[4, 1, 1, "", "Fossology"], [0, 0, 0, "-", "enums"], [1, 0, 0, "-", "exceptions"], [2, 0, 0, "-", "folders"], [3, 0, 0, "-", "foss_cli"], [4, 4, 1, "", "fossology_token"], [5, 0, 0, "-", "groups"], [7, 0, 0, "-", "items"], [8, 0, 0, "-", "jobs"], [9, 0, 0, "-", "license"], [11, 0, 0, "-", "obj"], [12, 0, 0, "-", "report"], [14, 0, 0, "-", "uploads"], [15, 0, 0, "-", "users"]], "fossology.Fossology": [[4, 2, 1, "", "get_health"], [4, 2, 1, "", "get_info"], [4, 2, 1, "", "get_self"]], "fossology.enums": [[0, 1, 1, "", "AccessLevel"], [0, 1, 1, "", "ClearingScope"], [0, 1, 1, "", "ClearingStatus"], [0, 1, 1, "", "ClearingType"], [0, 1, 1, "", "CopyrightStatus"], [0, 1, 1, "", "JobStatus"], [0, 1, 1, "", "LicenseType"], [0, 1, 1, "", "MemberPerm"], [0, 1, 1, "", "ObligationClass"], [0, 1, 1, "", "Permission"], [0, 1, 1, "", "PrevNextSelection"], [0, 1, 1, "", "ReportFormat"], [0, 1, 1, "", "SearchTypes"], [0, 1, 1, "", "TokenScope"]], "fossology.exceptions": [[1, 3, 1, "", "AuthenticationError"], [1, 3, 1, "", "AuthorizationError"], [1, 3, 1, "", "Error"], [1, 3, 1, "", "FossologyApiError"], [1, 3, 1, "", "FossologyUnsupported"]], "fossology.folders": [[2, 1, 1, "", "Folders"]], "fossology.folders.Folders": [[2, 2, 1, "", "copy_folder"], [2, 2, 1, "", "create_folder"], [2, 2, 1, "", "delete_folder"], [2, 2, 1, "", "detail_folder"], [2, 2, 1, "", "list_folders"], [2, 2, 1, "", "move_folder"], [2, 2, 1, "", "update_folder"]], "fossology.foss_cli": [[3, 4, 1, "", "check_get_access_level"], [3, 4, 1, "", "check_get_folder"], [3, 4, 1, "", "check_get_report_format"], [3, 4, 1, "", "get_newest_upload_of_file"], [3, 4, 1, "", "init_foss"], [3, 4, 1, "", "needs_later_initialization_of_foss_instance"]], "fossology.groups": [[5, 1, 1, "", "Groups"]], "fossology.groups.Groups": [[5, 2, 1, "", "add_group_member"], [5, 2, 1, "", "create_group"], [5, 2, 1, "", "delete_group"], [5, 2, 1, "", "delete_group_member"], [5, 2, 1, "", "list_group_members"], [5, 2, 1, "", "list_groups"]], "fossology.items": [[7, 1, 1, "", "Items"]], "fossology.items.Items": [[7, 2, 1, "", "get_bulk_history"], [7, 2, 1, "", "get_clearing_history"], [7, 2, 1, "", "get_prev_next"], [7, 2, 1, "", "item_copyrights"], [7, 2, 1, "", "item_info"], [7, 2, 1, "", "schedule_bulk_scan"]], "fossology.jobs": [[8, 1, 1, "", "Jobs"]], "fossology.jobs.Jobs": [[8, 2, 1, "", "detail_job"], [8, 2, 1, "", "list_jobs"], [8, 2, 1, "", "schedule_jobs"]], "fossology.license": [[9, 1, 1, "", "LicenseEndpoint"]], "fossology.license.LicenseEndpoint": [[9, 2, 1, "", "add_license"], [9, 2, 1, "", "detail_license"], [9, 2, 1, "", "list_licenses"], [9, 2, 1, "", "update_license"]], "fossology.obj": [[11, 1, 1, "", "Agents"], [11, 1, 1, "", "ApiInfo"], [11, 1, 1, "", "ApiLicense"], [11, 1, 1, "", "File"], [11, 1, 1, "", "FileInfo"], [11, 1, 1, "", "Findings"], [11, 1, 1, "", "Folder"], [11, 1, 1, "", "FossologyServer"], [11, 1, 1, "", "GetBulkHistory"], [11, 1, 1, "", "GetClearingHistory"], [11, 1, 1, "", "GetPrevNextItem"], [11, 1, 1, "", "Group"], [11, 1, 1, "", "Hash"], [11, 1, 1, "", "HealthInfo"], [11, 1, 1, "", "Job"], [11, 1, 1, "", "License"], [11, 1, 1, "", "Obligation"], [11, 1, 1, "", "PermGroups"], [11, 1, 1, "", "SearchResult"], [11, 1, 1, "", "Status"], [11, 1, 1, "", "Summary"], [11, 1, 1, "", "Upload"], [11, 1, 1, "", "UploadCopyrights"], [11, 1, 1, "", "UploadLicenses"], [11, 1, 1, "", "UploadPermGroups"], [11, 1, 1, "", "User"], [11, 1, 1, "", "UserGroupMember"]], "fossology.obj.Agents": [[11, 2, 1, "", "to_dict"], [11, 2, 1, "", "to_json"]], "fossology.obj.License": [[11, 2, 1, "", "to_dict"], [11, 2, 1, "", "to_json"]], "fossology.report": [[12, 1, 1, "", "Report"]], "fossology.report.Report": [[12, 2, 1, "", "download_report"], [12, 2, 1, "", "generate_report"]], "fossology.uploads": [[14, 1, 1, "", "Uploads"], [14, 4, 1, "", "list_uploads_parameters"]], "fossology.uploads.Uploads": [[14, 2, 1, "", "change_upload_permissions"], [14, 2, 1, "", "delete_upload"], [14, 2, 1, "", "detail_upload"], [14, 2, 1, "", "download_upload"], [14, 2, 1, "", "list_uploads"], [14, 2, 1, "", "move_upload"], [14, 2, 1, "", "update_upload"], [14, 2, 1, "", "upload_copyrights"], [14, 2, 1, "", "upload_file"], [14, 2, 1, "", "upload_licenses"], [14, 2, 1, "", "upload_permissions"], [14, 2, 1, "", "upload_summary"]], "fossology.users": [[15, 1, 1, "", "Users"]], "fossology.users.Users": [[15, 2, 1, "", "create_user"], [15, 2, 1, "", "delete_user"], [15, 2, 1, "", "detail_user"], [15, 2, 1, "", "list_users"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"]}, "titleterms": {"fossologi": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15], "enum": 0, "except": 1, "folder": [2, 13], "foss": 3, "cli": [3, 6], "group": [5, 13], "welcom": 6, "": 6, "document": 6, "usag": 6, "instal": 6, "us": 6, "api": 6, "contribut": 6, "develop": 6, "build": 6, "tag": 6, "test": 6, "item": 7, "job": [8, 13], "licens": 9, "log": 10, "object": 11, "report": [12, 13], "sampl": 13, "workflow": 13, "need": 13, "import": 13, "variabl": 13, "creat": 13, "jwt": 13, "token": 13, "login": 13, "server": 13, "If": 13, "upload": [13, 14], "file": 13, "start": 13, "default": 13, "scan": 13, "gener": 13, "delet": 13, "clean": 13, "up": 13, "user": 15}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Fossology Enums": [[0, "fossology-enums"]], "Fossology exceptions": [[1, "fossology-exceptions"]], "Fossology Folders": [[2, "fossology-folders"]], "Foss CLI": [[3, "foss-cli"]], "Fossology": [[4, "fossology"]], "Fossology Groups": [[5, "fossology-groups"]], "Welcome to fossology\u2019s documentation!": [[6, "welcome-to-fossology-s-documentation"]], "Documentation": [[6, "documentation"]], "Usage": [[6, "usage"]], "Installation": [[6, "installation"]], "Using the API": [[6, "using-the-api"]], "Using the CLI": [[6, "using-the-cli"]], "Contribute": [[6, "contribute"]], "Develop": [[6, "develop"]], "Build": [[6, "build"]], "Tag": [[6, "tag"]], "Test": [[6, "test"]], "Fossology Items": [[7, "fossology-items"]], "Fossology Jobs": [[8, "fossology-jobs"]], "Fossology License": [[9, "fossology-license"]], "Logging": [[10, "logging"]], "Fossology objects": [[11, "fossology-objects"]], "Fossology Report": [[12, "fossology-report"]], "Sample Workflow": [[13, "sample-workflow"]], "Needed imports and Variables": [[13, "needed-imports-and-variables"]], "Create JWT Token": [[13, "create-jwt-token"]], "Login to the Fossology Server": [[13, "login-to-the-fossology-server"]], "Create Folder If needed": [[13, "create-folder-if-needed"]], "Create Group If needed": [[13, "create-group-if-needed"]], "Upload File": [[13, "upload-file"]], "Start default scan jobs": [[13, "start-default-scan-jobs"]], "Generate report": [[13, "generate-report"]], "Delete folder": [[13, "delete-folder"]], "Clean up": [[13, "clean-up"]], "Fossology Uploads": [[14, "fossology-uploads"]], "Fossology Users": [[15, "fossology-users"]]}, "indexentries": {"accesslevel (class in fossology.enums)": [[0, "fossology.enums.AccessLevel"]], "clearingscope (class in fossology.enums)": [[0, "fossology.enums.ClearingScope"]], "clearingstatus (class in fossology.enums)": [[0, "fossology.enums.ClearingStatus"]], "clearingtype (class in fossology.enums)": [[0, "fossology.enums.ClearingType"]], "copyrightstatus (class in fossology.enums)": [[0, "fossology.enums.CopyrightStatus"]], "jobstatus (class in fossology.enums)": [[0, "fossology.enums.JobStatus"]], "licensetype (class in fossology.enums)": [[0, "fossology.enums.LicenseType"]], "memberperm (class in fossology.enums)": [[0, "fossology.enums.MemberPerm"]], "obligationclass (class in fossology.enums)": [[0, "fossology.enums.ObligationClass"]], "permission (class in fossology.enums)": [[0, "fossology.enums.Permission"]], "prevnextselection (class in fossology.enums)": [[0, "fossology.enums.PrevNextSelection"]], "reportformat (class in fossology.enums)": [[0, "fossology.enums.ReportFormat"]], "searchtypes (class in fossology.enums)": [[0, "fossology.enums.SearchTypes"]], "tokenscope (class in fossology.enums)": [[0, "fossology.enums.TokenScope"]], "fossology.enums": [[0, "module-fossology.enums"]], "module": [[0, "module-fossology.enums"], [1, "module-fossology.exceptions"], [2, "module-fossology.folders"], [3, "module-fossology.foss_cli"], [4, "module-fossology"], [5, "module-fossology.groups"], [7, "module-fossology.items"], [8, "module-fossology.jobs"], [9, "module-fossology.license"], [11, "module-fossology.obj"], [12, "module-fossology.report"], [14, "module-fossology.uploads"], [15, "module-fossology.users"]], "authenticationerror": [[1, "fossology.exceptions.AuthenticationError"]], "authorizationerror": [[1, "fossology.exceptions.AuthorizationError"]], "error": [[1, "fossology.exceptions.Error"]], "fossologyapierror": [[1, "fossology.exceptions.FossologyApiError"]], "fossologyunsupported": [[1, "fossology.exceptions.FossologyUnsupported"]], "fossology.exceptions": [[1, "module-fossology.exceptions"]], "folders (class in fossology.folders)": [[2, "fossology.folders.Folders"]], "copy_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.copy_folder"]], "create_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.create_folder"]], "delete_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.delete_folder"]], "detail_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.detail_folder"]], "fossology.folders": [[2, "module-fossology.folders"]], "list_folders() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.list_folders"]], "move_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.move_folder"]], "update_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.update_folder"]], "check_get_access_level() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.check_get_access_level"]], "check_get_folder() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.check_get_folder"]], "check_get_report_format() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.check_get_report_format"]], "fossology.foss_cli": [[3, "module-fossology.foss_cli"]], "get_newest_upload_of_file() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.get_newest_upload_of_file"]], "init_foss() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.init_foss"]], "needs_later_initialization_of_foss_instance() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.needs_later_initialization_of_foss_instance"]], "fossology (class in fossology)": [[4, "fossology.Fossology"]], "fossology": [[4, "module-fossology"]], "fossology_token() (in module fossology)": [[4, "fossology.fossology_token"]], "get_health() (fossology.fossology method)": [[4, "fossology.Fossology.get_health"]], "get_info() (fossology.fossology method)": [[4, "fossology.Fossology.get_info"]], "get_self() (fossology.fossology method)": [[4, "fossology.Fossology.get_self"]], "groups (class in fossology.groups)": [[5, "fossology.groups.Groups"]], "add_group_member() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.add_group_member"]], "create_group() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.create_group"]], "delete_group() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.delete_group"]], "delete_group_member() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.delete_group_member"]], "fossology.groups": [[5, "module-fossology.groups"]], "list_group_members() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.list_group_members"]], "list_groups() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.list_groups"]], "items (class in fossology.items)": [[7, "fossology.items.Items"]], "fossology.items": [[7, "module-fossology.items"]], "get_bulk_history() (fossology.items.items method)": [[7, "fossology.items.Items.get_bulk_history"]], "get_clearing_history() (fossology.items.items method)": [[7, "fossology.items.Items.get_clearing_history"]], "get_prev_next() (fossology.items.items method)": [[7, "fossology.items.Items.get_prev_next"]], "item_copyrights() (fossology.items.items method)": [[7, "fossology.items.Items.item_copyrights"]], "item_info() (fossology.items.items method)": [[7, "fossology.items.Items.item_info"]], "schedule_bulk_scan() (fossology.items.items method)": [[7, "fossology.items.Items.schedule_bulk_scan"]], "jobs (class in fossology.jobs)": [[8, "fossology.jobs.Jobs"]], "detail_job() (fossology.jobs.jobs method)": [[8, "fossology.jobs.Jobs.detail_job"]], "fossology.jobs": [[8, "module-fossology.jobs"]], "list_jobs() (fossology.jobs.jobs method)": [[8, "fossology.jobs.Jobs.list_jobs"]], "schedule_jobs() (fossology.jobs.jobs method)": [[8, "fossology.jobs.Jobs.schedule_jobs"]], "licenseendpoint (class in fossology.license)": [[9, "fossology.license.LicenseEndpoint"]], "add_license() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.add_license"]], "detail_license() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.detail_license"]], "fossology.license": [[9, "module-fossology.license"]], "list_licenses() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.list_licenses"]], "update_license() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.update_license"]], "agents (class in fossology.obj)": [[11, "fossology.obj.Agents"]], "apiinfo (class in fossology.obj)": [[11, "fossology.obj.ApiInfo"]], "apilicense (class in fossology.obj)": [[11, "fossology.obj.ApiLicense"]], "file (class in fossology.obj)": [[11, "fossology.obj.File"]], "fileinfo (class in fossology.obj)": [[11, "fossology.obj.FileInfo"]], "findings (class in fossology.obj)": [[11, "fossology.obj.Findings"]], "folder (class in fossology.obj)": [[11, "fossology.obj.Folder"]], "fossologyserver (class in fossology.obj)": [[11, "fossology.obj.FossologyServer"]], "getbulkhistory (class in fossology.obj)": [[11, "fossology.obj.GetBulkHistory"]], "getclearinghistory (class in fossology.obj)": [[11, "fossology.obj.GetClearingHistory"]], "getprevnextitem (class in fossology.obj)": [[11, "fossology.obj.GetPrevNextItem"]], "group (class in fossology.obj)": [[11, "fossology.obj.Group"]], "hash (class in fossology.obj)": [[11, "fossology.obj.Hash"]], "healthinfo (class in fossology.obj)": [[11, "fossology.obj.HealthInfo"]], "job (class in fossology.obj)": [[11, "fossology.obj.Job"]], "license (class in fossology.obj)": [[11, "fossology.obj.License"]], "obligation (class in fossology.obj)": [[11, "fossology.obj.Obligation"]], "permgroups (class in fossology.obj)": [[11, "fossology.obj.PermGroups"]], "searchresult (class in fossology.obj)": [[11, "fossology.obj.SearchResult"]], "status (class in fossology.obj)": [[11, "fossology.obj.Status"]], "summary (class in fossology.obj)": [[11, "fossology.obj.Summary"]], "upload (class in fossology.obj)": [[11, "fossology.obj.Upload"]], "uploadcopyrights (class in fossology.obj)": [[11, "fossology.obj.UploadCopyrights"]], "uploadlicenses (class in fossology.obj)": [[11, "fossology.obj.UploadLicenses"]], "uploadpermgroups (class in fossology.obj)": [[11, "fossology.obj.UploadPermGroups"]], "user (class in fossology.obj)": [[11, "fossology.obj.User"]], "usergroupmember (class in fossology.obj)": [[11, "fossology.obj.UserGroupMember"]], "fossology.obj": [[11, "module-fossology.obj"]], "to_dict() (fossology.obj.agents method)": [[11, "fossology.obj.Agents.to_dict"]], "to_dict() (fossology.obj.license method)": [[11, "fossology.obj.License.to_dict"]], "to_json() (fossology.obj.agents method)": [[11, "fossology.obj.Agents.to_json"]], "to_json() (fossology.obj.license method)": [[11, "fossology.obj.License.to_json"]], "report (class in fossology.report)": [[12, "fossology.report.Report"]], "download_report() (fossology.report.report method)": [[12, "fossology.report.Report.download_report"]], "fossology.report": [[12, "module-fossology.report"]], "generate_report() (fossology.report.report method)": [[12, "fossology.report.Report.generate_report"]], "uploads (class in fossology.uploads)": [[14, "fossology.uploads.Uploads"]], "change_upload_permissions() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.change_upload_permissions"]], "delete_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.delete_upload"]], "detail_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.detail_upload"]], "download_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.download_upload"]], "fossology.uploads": [[14, "module-fossology.uploads"]], "list_uploads() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.list_uploads"]], "list_uploads_parameters() (in module fossology.uploads)": [[14, "fossology.uploads.list_uploads_parameters"]], "move_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.move_upload"]], "update_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.update_upload"]], "upload_copyrights() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_copyrights"]], "upload_file() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_file"]], "upload_licenses() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_licenses"]], "upload_permissions() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_permissions"]], "upload_summary() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_summary"]], "users (class in fossology.users)": [[15, "fossology.users.Users"]], "create_user() (fossology.users.users method)": [[15, "fossology.users.Users.create_user"]], "delete_user() (fossology.users.users method)": [[15, "fossology.users.Users.delete_user"]], "detail_user() (fossology.users.users method)": [[15, "fossology.users.Users.detail_user"]], "fossology.users": [[15, "module-fossology.users"]], "list_users() (fossology.users.users method)": [[15, "fossology.users.Users.list_users"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["enums", "exceptions", "folders", "foss_cli", "fossology", "groups", "index", "items", "jobs", "license", "logging", "obj", "report", "sample_workflow", "uploads", "users"], "filenames": ["enums.rst", "exceptions.rst", "folders.rst", "foss_cli.rst", "fossology.rst", "groups.rst", "index.rst", "items.rst", "jobs.rst", "license.rst", "logging.rst", "obj.rst", "report.rst", "sample_workflow.rst", "uploads.rst", "users.rst"], "titles": ["Fossology Enums", "Fossology exceptions", "Fossology Folders", "Foss CLI", "Fossology", "Fossology Groups", "Welcome to fossology\u2019s documentation!", "Fossology Items", "Fossology Jobs", "Fossology License", "Logging", "Fossology objects", "Fossology Report", "Sample Workflow", "Fossology Uploads", "Fossology Users"], "terms": {"The": [0, 1, 2, 3, 4, 6, 8, 11, 12, 13, 14], "python": [0, 3, 6, 10, 11, 13, 14], "deriv": [0, 11], "from": [0, 4, 5, 6, 7, 9, 11, 12, 13, 14, 15], "rest": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "data": [0, 7, 8, 9, 11, 13, 14, 15], "class": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "accesslevel": [0, 3, 11, 13, 14, 15], "valu": [0, 3, 6, 11], "name": [0, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15], "none": [0, 1, 2, 3, 4, 7, 8, 9, 11, 12, 14, 15], "modul": [0, 1, 10], "qualnam": 0, "type": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "start": [0, 6, 11], "1": [0, 6, 8, 9, 11, 12, 14], "boundari": 0, "avail": [0, 3, 6, 7, 8, 13, 14], "access": [0, 2, 3, 5, 6, 7, 8, 9, 12, 13, 14, 15], "level": [0, 3, 5, 6, 11], "upload": [0, 3, 6, 7, 8, 11, 12], "privat": [0, 6], "protect": [0, 6, 14], "public": [0, 6, 9, 11, 13, 14, 15], "clearingscop": 0, "scope": [0, 4, 5, 6, 11], "clear": [0, 7, 11, 13, 14], "local": [0, 6, 13, 14], "packag": [0, 6, 8, 11, 13, 14, 15], "global": [0, 14], "clearingstatu": [0, 11, 14], "status": 0, "open": [0, 6, 9, 12, 13, 14], "inprogress": [0, 14], "close": [0, 11, 14], "reject": [0, 14], "clearingtyp": 0, "to_be_discuss": 0, "irrelev": 0, "identifi": 0, "do_not_us": 0, "non_funct": 0, "copyrightstatu": [0, 7], "statu": [0, 7, 11, 14], "copyright": [0, 7, 11, 13, 14], "activ": [0, 9, 13], "inact": 0, "jobstatu": 0, "job": [0, 6, 11], "complet": [0, 6], "fail": [0, 2, 4, 5, 6, 7, 8, 9, 12, 14, 15], "queu": 0, "process": [0, 11], "licensetyp": [0, 9], "licens": [0, 7, 11, 13, 14], "candid": [0, 9, 11], "main": [0, 4, 6, 11], "all": [0, 2, 5, 6, 7, 8, 9, 12, 13, 14, 15], "memberperm": [0, 5], "group": [0, 2, 6, 8, 9, 11, 12, 14], "member": [0, 5, 11], "permiss": [0, 5, 11, 14], "user": [0, 2, 4, 5, 6, 8, 11, 13, 14], "admin": [0, 5, 6, 8, 11], "advisor": [0, 11], "obligationclass": 0, "classif": [0, 11], "an": [0, 4, 6, 7, 9, 13, 14], "oblig": [0, 9, 11], "green": 0, "white": 0, "yellow": 0, "red": [0, 9], "read_onli": 0, "read_writ": 0, "clearing_admin": 0, "prevnextselect": [0, 7], "file": [0, 6, 7, 11, 14], "select": [0, 7, 14], "prev": [0, 7, 11], "next": [0, 7, 11], "endpoint": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15], "withlicens": 0, "noclear": 0, "reportformat": [0, 3, 6, 12], "report": [0, 6], "format": [0, 3, 11, 12, 14], "dep5": [0, 6], "spdx2": [0, 6], "spdx2tv": 0, "readmeoss": [0, 6, 12], "unifiedreport": [0, 6], "searchtyp": 0, "item": [0, 11], "can": [0, 3, 6, 13], "search": [0, 11], "allfil": 0, "contain": [0, 6, 8, 14], "directori": [0, 6, 11], "tokenscop": [0, 4, 6, 13], "api": [0, 2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15], "token": [0, 3, 4, 6], "read": [0, 4, 6, 13], "onli": [0, 5, 6, 8, 9, 14], "limit": [0, 5, 8, 14], "get": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15], "call": [0, 2, 4, 5, 6, 7, 8, 9, 12, 13, 14, 15], "write": [0, 6, 12, 13], "requir": [0, 6, 14], "other": [0, 11, 14], "than": 0, "authenticationerror": [1, 4], "descript": [1, 2, 6, 11, 13, 14, 15], "respons": [1, 11], "authent": [1, 2, 4, 11], "error": [1, 4, 11], "authorizationerror": [1, 2, 7, 12, 14], "author": [1, 2, 7, 12, 14], "base": [1, 3, 6, 13], "thi": [1, 6, 9, 10, 13, 14], "fossologyapierror": [1, 2, 4, 5, 7, 8, 9, 12, 13, 14, 15], "dure": [1, 6], "request": [1, 2, 3, 4, 6, 7, 8, 9, 13, 15], "fossologyunsupport": [1, 3], "option": [1, 2, 3, 6, 7, 8, 9, 10], "support": [1, 6], "method": [2, 5, 6, 7, 8, 9, 11, 12, 14, 15], "us": [2, 3, 4, 5, 7, 8, 9, 10, 12, 13, 14, 15], "dedic": [2, 5, 7, 8, 9, 12, 14, 15], "relat": [2, 5, 6, 7, 8, 9, 12, 14, 15], "copy_fold": 2, "parent": [2, 11], "copi": [2, 14], "paramet": [2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15], "object": 2, "new": [2, 4, 6, 9, 14, 15], "return": [2, 3, 4, 5, 7, 8, 9, 11, 12, 14, 15], "updat": [2, 9, 14], "rais": [2, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15], "create_fold": [2, 6, 13], "str": [2, 3, 4, 5, 7, 8, 9, 11, 12, 14], "creat": [2, 3, 4, 5, 6, 8, 11, 15], "sub": [2, 11], "must": 2, "uniqu": [2, 11], "under": [2, 6], "same": 2, "ar": [2, 6, 7, 8, 9, 11, 13, 14], "case": [2, 6], "insensit": 2, "post": [2, 4, 5, 7, 8, 9, 14, 15], "id": [2, 5, 7, 8, 9, 11, 12, 13, 14, 15], "meaning": [2, 10], "default": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14], "string": [2, 4, 8, 11, 12, 14], "chosen": 2, "newli": 2, "alreadi": [2, 11, 13], "exist": [2, 13], "i": [2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14], "delete_fold": [2, 13], "delet": [2, 5, 14, 15], "detail_fold": 2, "folder_id": 2, "int": [2, 5, 7, 8, 9, 11, 12, 14, 15], "detail": [2, 4, 6, 8, 10, 13, 14, 15], "analyz": [2, 13], "list_fold": 2, "list": [2, 5, 6, 7, 8, 9, 11, 14, 15], "move_fold": 2, "move": [2, 14], "update_fold": 2, "": [2, 4, 10, 11, 15], "patch": [2, 6, 9, 14], "command": [3, 6], "foss_cli": [3, 6], "cmdline": 3, "interfac": [3, 6, 13], "provid": [3, 11], "commun": 3, "fossologi": [3, 10], "server": [3, 4, 6, 7, 11, 14], "log": [3, 6, 8, 13], "implement": [3, 6], "standard": [3, 10], "framework": 3, "adapt": 3, "v": [3, 6], "vv": [3, 6], "could": [3, 6, 13], "sent": 3, "consol": [3, 10], "log_to_fil": 3, "log_fil": 3, "log_file_nam": 3, "filenam": [3, 11, 13], "check_get_access_level": 3, "check": [3, 11], "given": [3, 5, 6, 8, 11, 12, 13, 14], "valid": 3, "enum": [3, 6, 13, 14], "check_get_fold": 3, "ctx": 3, "context": [3, 6], "folder_nam": [3, 6, 13], "folder": [3, 6, 7, 8, 11, 14], "instanc": [3, 4, 6, 11, 13, 15], "click": 3, "core": 3, "multipl": [3, 13], "time": [3, 7, 11, 12, 14], "found": [3, 4, 11], "check_get_report_format": 3, "get_newest_upload_of_fil": 3, "newest": [3, 6], "init_foss": 3, "initi": [3, 4, 6], "store": [3, 6, 13], "e": [3, 4, 6, 11, 13, 14], "keyerror": 3, "bearer": 3, "set": [3, 13], "environ": [3, 6, 13], "foss_inst": 3, "needs_later_initialization_of_foss_inst": 3, "later": 3, "indic": 3, "bool": [3, 5, 8, 9, 11, 14], "session": 4, "relev": [4, 13], "inform": [4, 6, 8, 11, 14], "url": [4, 6, 9, 11, 13, 14], "version": [4, 6, 11], "v2": 4, "against": [4, 11], "run": [4, 6, 11], "perform": [4, 14], "exampl": [4, 6, 9, 12, 13, 14, 15], "import": [4, 6, 12, 14], "foss": [4, 6, 9, 12, 13, 14, 15], "foss_url": [4, 12, 14], "foss_token": [4, 12, 14], "gener": [4, 6, 9, 10, 12], "ui": [4, 13], "couldn": 4, "t": 4, "get_health": 4, "apiinfo": [4, 11], "health": [4, 11], "healthinfo": [4, 11], "get_info": 4, "info": [4, 7, 11], "get_self": 4, "first": [4, 8, 13], "popul": 4, "variabl": 4, "self": 4, "fossology_token": [4, 6, 13], "usernam": [4, 6, 11, 12, 13, 14], "password": [4, 6, 13, 15], "token_nam": [4, 6, 13], "token_scop": 4, "token_expir": 4, "obj": [4, 11, 13], "http": [4, 6, 9, 13, 14], "com": [4, 6, 13, 14, 15], "repo": [4, 6, 13], "me": [4, 14], "mypassword": 4, "mytoken": 4, "expir": [4, 6], "date": [4, 11, 14], "g": [4, 6, 11, 13, 14], "2019": 4, "12": 4, "25": 4, "max": 4, "30": [4, 14], "dai": 4, "incorrect": 4, "anoth": [4, 12, 14], "occur": 4, "add_group_memb": 5, "group_id": 5, "user_id": [5, 15], "perm": [5, 11, 14], "add": [5, 6, 7, 9, 14], "create_group": [5, 6, 13], "delete_group": 5, "delete_group_memb": 5, "list_group_memb": 5, "usergroupmemb": [5, 11], "list_group": 5, "fals": [5, 7, 8, 9, 14], "If": [5, 6, 12, 14], "true": [5, 7, 8, 9, 13, 14, 15], "wether": [5, 14], "A": [6, 13, 15], "simpl": 6, "wrapper": 6, "see": [6, 13, 14], "openapi": 6, "specif": [6, 7, 8, 12, 14], "librari": 6, "current": [6, 11, 14], "releas": 6, "compat": 6, "4": [6, 11], "0": [6, 8, 9, 11, 12, 13, 14, 15], "2": [6, 9, 11], "note": 6, "you": [6, 14], "miss": 6, "pleas": 6, "issu": 6, "pull": 6, "github": [6, 13, 14], "page": [6, 8, 9, 14], "project": 6, "pypi": 6, "org": [6, 9], "depend": 6, "pip": 6, "either": 6, "edit": [6, 14], "account": 6, "fossology_serv": [6, 13], "absens": 6, "trail": 6, "slash": 6, "otherwis": 6, "fossology_us": [6, 13], "fossi": [6, 13], "fossology_password": 6, "fossy_token": 6, "3": 6, "need": 6, "anymor": 6, "print": [6, 13], "f": [6, 13], "also": 6, "offer": 6, "line": 6, "simplifi": 6, "interact": 6, "your": [6, 13, 14], "To": [6, 10], "help": 6, "arg": 6, "configur": [6, 10, 11, 14], "config": 6, "enter": [6, 13], "within": 6, "ini": 6, "On": 6, "subsequ": [6, 13], "those": 6, "reus": [6, 8, 11, 13], "re": 6, "onc": 6, "verbos": 6, "increas": 6, "debug": [6, 10], "statement": 6, "foss_cli_result": 6, "fossgroup": 6, "fossfold": 6, "folder_group": 6, "folder_descript": 6, "upload_fil": [6, 13, 14], "zlib_1": 6, "11": 6, "dfsg": 6, "0ubuntu2": 6, "debian": 6, "tar": [6, 13], "xz": [6, 13], "access_level": [6, 13, 14], "sourc": [6, 13], "scan": [6, 7, 11], "workflow": 6, "includ": [6, 13], "start_workflow": 6, "file_nam": 6, "text": [6, 7, 9, 11, 13], "file_descript": 6, "dry_run": 6, "no_dry_run": 6, "do": [6, 13], "show": [6, 13, 14], "what": 6, "would": 6, "done": [6, 13], "output": 6, "reuse_newest_upload": 6, "no_reuse_newest_upload": 6, "reuse_newest_job": 6, "no_reuse_newest_job": 6, "schedul": [6, 7, 8, 11], "report_format": [6, 12], "spdxtv": 6, "messag": [6, 10, 13], "exit": 6, "form": 6, "bug": 6, "featur": 6, "merg": [6, 9], "proper": 6, "docstr": 6, "function": [6, 12, 14], "extend": 6, "testsuit": 6, "poetri": 6, "pytest": 6, "websit": 6, "automat": 6, "sphinx": 6, "autodoc": 6, "extens": 6, "hint": 6, "avoid": 6, "whole": 6, "branch": [6, 11], "chang": [6, 14], "touch": 6, "code": [6, 13], "feat": 6, "someth": 6, "test_foss_cli_": 6, "static": 6, "site": 6, "action": [6, 14], "everi": [6, 11], "push": 6, "gh": 6, "james": 6, "deploi": [6, 11], "b": 6, "html": [6, 13], "doc": 6, "cleanup": [6, 13], "rm": 6, "r": [6, 13], "dist": 6, "each": 6, "about": [6, 8, 10, 11, 14], "ad": [6, 7, 8, 9, 11, 13], "git": [6, 14], "vx": 6, "x": [6, 8], "m": 6, "major": 6, "minor": 6, "origin": 6, "correspond": [6, 13], "expect": 6, "hostnam": 6, "latest": 6, "docker": 6, "hub": 6, "xjf": 6, "files_11": [6, 13], "c": 6, "tmp": [6, 14], "mount": 6, "src": 6, "dst": 6, "bind": 6, "p": 6, "80": 6, "suit": 6, "coverag": 6, "get_bulk_histori": 7, "item_id": 7, "getbulkhistori": [7, 11], "bulk": [7, 11], "histori": [7, 11], "itemid": 7, "decis": [7, 11, 13, 14], "get_clearing_histori": 7, "getclearinghistori": [7, 11], "specifi": [7, 11, 12, 14], "get_prev_next": 7, "getprevnextitem": [7, 11], "index": 7, "previou": [7, 11], "tell": 7, "how": [7, 12, 14], "item_copyright": 7, "total": [7, 8, 11, 14], "mention": 7, "tree": [7, 11], "totalcopyright": 7, "number": [7, 8, 9, 11, 14], "uploadtre": 7, "item_info": 7, "fileinfo": [7, 11], "schedule_bulk_scan": 7, "spec": [7, 8], "dict": [7, 8, 11, 14, 15], "bodi": [7, 8, 9], "follow": [7, 8], "bulk_scan_spec": 7, "bulkact": 7, "licenseshortnam": 7, "mit": 7, "licensetext": 7, "acknowledg": 7, "comment": [7, 11, 14], "licenseact": 7, "remov": [7, 11], "reftext": 7, "refer": [7, 10, 11], "bulkscop": 7, "forcedecis": 7, "ignoreirr": 7, "delimit": 7, "scanonlyfind": 7, "detail_job": 8, "job_id": 8, "wait": [8, 12, 14], "timeout": 8, "10": [8, 12, 14], "boolean": [8, 9, 11, 14], "until": [8, 12, 14], "finish": 8, "stop": [8, 12, 14], "after": [8, 12, 13, 14], "second": [8, 12, 14], "list_job": 8, "page_s": [8, 9, 14], "100": [8, 9, 14], "all_pag": [8, 9, 14], "tupl": [8, 9, 12, 14], "answer": 8, "20": [8, 12, 14], "result": [8, 9, 11], "maximum": [8, 9], "per": [8, 9, 14], "retriev": [8, 9, 10], "schedule_job": [8, 13], "job_spec": 8, "analysi": [8, 13], "bucket": [8, 11, 13, 15], "copyright_email_author": [8, 11, 13, 15], "ecc": [8, 11, 13, 15], "keyword": [8, 11, 13, 15], "monk": [8, 11, 13, 14, 15], "mime": [8, 13, 15], "nomo": [8, 11, 13, 14, 15], "ojo": [8, 11, 13, 14, 15], "specific_ag": [8, 13], "decid": [8, 13], "nomos_monk": [8, 13], "bulk_reus": [8, 13], "new_scann": [8, 13], "ojo_decid": [8, 13], "reuse_upload": [8, 13], "reuse_group": [8, 13], "reuse_main": [8, 13], "reuse_enhanc": [8, 13], "reuse_report": [8, 13], "reuse_copyright": [8, 13], "which": [8, 11, 12, 14], "choos": [8, 12], "while": [8, 12, 14], "licenseendpoint": 9, "add_licens": 9, "merge_request": 9, "db": [9, 11], "here": 9, "new_licens": 9, "gpl": 9, "gnu": 9, "www": 9, "txt": 9, "detail_licens": 9, "shortnam": [9, 11], "short": [9, 11], "belong": [9, 14], "associ": [9, 11], "list_licens": 9, "kind": 9, "update_licens": 9, "fullnam": [9, 11], "risk": [9, 11], "snippet": 10, "logger": 10, "getlogg": 10, "streamhandl": 10, "setlevel": 10, "formatt": 10, "asctim": 10, "levelnam": 10, "setformatt": 10, "addhandl": 10, "offici": 10, "document": [10, 11], "further": [10, 11, 13], "possibl": [10, 13], "agent": [11, 13, 14, 15], "mimetyp": 11, "kwarg": 11, "repres": 11, "kei": 11, "word": 11, "argument": [11, 14], "handl": 11, "ani": 11, "to_dict": 11, "to_json": 11, "json": 11, "secur": 11, "contact": 11, "servic": 11, "addit": 11, "allow": 11, "email": [11, 15], "apilicens": 11, "fossologyserv": 11, "link": 11, "hash": 11, "find": [11, 13, 14], "filesearch": 11, "view_info": 11, "meta_info": 11, "package_info": 11, "tag_info": 11, "reuse_info": 11, "view": 11, "meta": 11, "tag": 11, "scanner": 11, "conclus": 11, "conclud": 11, "branchnam": 11, "commithash": 11, "commitd": 11, "builddat": 11, "commit": 11, "iso8601": 11, "were": 11, "built": 11, "bulkid": 11, "clearingeventid": 11, "match": [11, 14], "tri": 11, "addedlicens": 11, "iter": 11, "removedlicens": 11, "event": 11, "whether": 11, "who": 11, "previtemid": 11, "nextitemid": 11, "prevnext": 11, "sha1": 11, "md5": 11, "sha256": 11, "size": 11, "sum": 11, "mda": 11, "byte": 11, "overal": 11, "ok": 11, "warn": 11, "queuedat": 11, "uploadid": 11, "userid": 11, "groupid": 11, "eta": 11, "wo": 11, "estim": 11, "termin": 11, "iscandid": 11, "full": 11, "topic": 11, "attent": 11, "should": 11, "permgroup": 11, "group_pk": 11, "group_nam": [11, 13], "respect": [11, 14], "searchresult": 11, "uploadtreeid": 11, "where": 11, "ha": [11, 13], "been": [11, 13], "system": 11, "summari": [11, 14], "uploadnam": 11, "mainlicens": 11, "uniquelicens": 11, "totallicens": 11, "uniqueconcludedlicens": 11, "totalconcludedlicens": 11, "filestobeclear": 11, "filesclear": 11, "copyrightcount": 11, "remain": 11, "folderid": 11, "foldernam": 11, "uploadd": 11, "assigne": [11, 14], "assigneed": 11, "closingd": 11, "assign": [11, 14], "uploadcopyright": 11, "filepath": 11, "rel": 11, "path": [11, 13, 14], "uploadlicens": [11, 14], "uploadpermgroup": 11, "publicperm": 11, "arrai": 11, "rootfolderid": [11, 15], "emailnotif": [11, 15], "default_group": 11, "tbd": 11, "root": 11, "notif": 11, "group_perm": 11, "structur": 11, "download_report": [12, 13], "report_id": [12, 13], "wait_tim": [12, 14], "download": [12, 13, 14], "readi": [12, 14], "look": [12, 14], "retri": [12, 14], "determin": [12, 14], "long": [12, 14], "period": [12, 14], "shall": [12, 14], "interv": [12, 14], "header": [12, 14], "try": [12, 13, 14], "attempt": [12, 14], "generate_report": [12, 13], "detail_upload": [12, 14], "up": [12, 14], "minut": [12, 14], "report_cont": 12, "report_nam": 12, "120": [12, 14], "wb": [12, 13], "report_fil": 12, "custom": [12, 13, 14], "instead": [12, 14], "content": [12, 13, 14], "tryagain": [12, 14], "out": [12, 14], "small": 13, "necessari": 13, "visibl": 13, "o": 13, "sy": 13, "pathlib": 13, "secret": 13, "getpass": 13, "except": 13, "fossology_user_pass": 13, "path_to_token_fil": 13, "cwd": 13, "pw": 13, "els": 13, "credenti": 13, "test": 13, "input": 13, "token_urlsaf": 13, "8": 13, "seen": 13, "databas": 13, "w": 13, "fp": 13, "len": 13, "load": 13, "awesomefossfold": 13, "folder_desc": 13, "awesomeprojectsourc": 13, "test_fold": 13, "rootfold": [13, 14], "restrict": 13, "resourc": 13, "io": 13, "Not": 13, "pass": [13, 14], "we": 13, "our": 13, "repositori": [13, 14], "my_bas": 13, "path_to_upload_fil": 13, "blob": 13, "master": [13, 14], "my_upload": [13, 14], "via": 13, "lib": 13, "archiv": [13, 14], "trigger": 13, "There": 13, "differ": 13, "export": 13, "control": 13, "furthermor": 13, "compon": 13, "step": 13, "best": 13, "explain": 13, "web": 13, "below": 13, "job_specif": 13, "resembl": 13, "button": 13, "detailed_job": 13, "disk": 13, "wa": 13, "written": 13, "unlink": 13, "change_upload_permiss": 14, "all_upload": 14, "new_permiss": 14, "public_permiss": 14, "put": 14, "want": 14, "delete_upload": 14, "chose": 14, "upload_id": 14, "long_upload": 14, "5": 14, "download_upload": 14, "its": 14, "list_upload": 14, "recurs": 14, "sinc": 14, "accord": 14, "filter": 14, "criteria": 14, "own": 14, "children": 14, "pattern": 14, "unassign": 14, "yyyi": 14, "mm": 14, "dd": 14, "fetch": 14, "move_upload": 14, "destin": 14, "update_upload": 14, "state": 14, "ignor": 14, "empti": 14, "upload_copyright": 14, "gather": 14, "vc": 14, "apply_glob": 14, "ignore_scm": 14, "client": 14, "my": 14, "zip": 14, "product": 14, "vcstype": 14, "vcsurl": 14, "vcsname": 14, "vcsusernam": 14, "vcspassword": 14, "vcs_upload": 14, "accept": 14, "maxrecursiondepth": 14, "url_upload": 14, "server_upload": 14, "onlin": 14, "appli": 14, "scm": 14, "svn": 14, "tf": 14, "upload_licens": 14, "ninka": 14, "reportimport": 14, "expos": 14, "upload_permiss": 14, "upload_summari": 14, "list_uploads_paramet": 14, "helper": 14, "queri": 14, "create_us": 15, "user_spec": 15, "brand": 15, "defaultgroup": 15, "reso": 15, "heritag": 15, "defaultbucketpool": 15, "user_pass": 15, "defaultvis": 15, "creation": 15, "delete_us": 15, "detail_us": 15, "list_us": 15}, "objects": {"": [[4, 0, 0, "-", "fossology"]], "fossology": [[4, 1, 1, "", "Fossology"], [0, 0, 0, "-", "enums"], [1, 0, 0, "-", "exceptions"], [2, 0, 0, "-", "folders"], [3, 0, 0, "-", "foss_cli"], [4, 4, 1, "", "fossology_token"], [5, 0, 0, "-", "groups"], [7, 0, 0, "-", "items"], [8, 0, 0, "-", "jobs"], [9, 0, 0, "-", "license"], [11, 0, 0, "-", "obj"], [12, 0, 0, "-", "report"], [14, 0, 0, "-", "uploads"], [15, 0, 0, "-", "users"]], "fossology.Fossology": [[4, 2, 1, "", "get_health"], [4, 2, 1, "", "get_info"], [4, 2, 1, "", "get_self"]], "fossology.enums": [[0, 1, 1, "", "AccessLevel"], [0, 1, 1, "", "ClearingScope"], [0, 1, 1, "", "ClearingStatus"], [0, 1, 1, "", "ClearingType"], [0, 1, 1, "", "CopyrightStatus"], [0, 1, 1, "", "JobStatus"], [0, 1, 1, "", "LicenseType"], [0, 1, 1, "", "MemberPerm"], [0, 1, 1, "", "ObligationClass"], [0, 1, 1, "", "Permission"], [0, 1, 1, "", "PrevNextSelection"], [0, 1, 1, "", "ReportFormat"], [0, 1, 1, "", "SearchTypes"], [0, 1, 1, "", "TokenScope"]], "fossology.exceptions": [[1, 3, 1, "", "AuthenticationError"], [1, 3, 1, "", "AuthorizationError"], [1, 3, 1, "", "Error"], [1, 3, 1, "", "FossologyApiError"], [1, 3, 1, "", "FossologyUnsupported"]], "fossology.folders": [[2, 1, 1, "", "Folders"]], "fossology.folders.Folders": [[2, 2, 1, "", "copy_folder"], [2, 2, 1, "", "create_folder"], [2, 2, 1, "", "delete_folder"], [2, 2, 1, "", "detail_folder"], [2, 2, 1, "", "list_folders"], [2, 2, 1, "", "move_folder"], [2, 2, 1, "", "update_folder"]], "fossology.foss_cli": [[3, 4, 1, "", "check_get_access_level"], [3, 4, 1, "", "check_get_folder"], [3, 4, 1, "", "check_get_report_format"], [3, 4, 1, "", "get_newest_upload_of_file"], [3, 4, 1, "", "init_foss"], [3, 4, 1, "", "needs_later_initialization_of_foss_instance"]], "fossology.groups": [[5, 1, 1, "", "Groups"]], "fossology.groups.Groups": [[5, 2, 1, "", "add_group_member"], [5, 2, 1, "", "create_group"], [5, 2, 1, "", "delete_group"], [5, 2, 1, "", "delete_group_member"], [5, 2, 1, "", "list_group_members"], [5, 2, 1, "", "list_groups"]], "fossology.items": [[7, 1, 1, "", "Items"]], "fossology.items.Items": [[7, 2, 1, "", "get_bulk_history"], [7, 2, 1, "", "get_clearing_history"], [7, 2, 1, "", "get_prev_next"], [7, 2, 1, "", "item_copyrights"], [7, 2, 1, "", "item_info"], [7, 2, 1, "", "schedule_bulk_scan"]], "fossology.jobs": [[8, 1, 1, "", "Jobs"]], "fossology.jobs.Jobs": [[8, 2, 1, "", "detail_job"], [8, 2, 1, "", "list_jobs"], [8, 2, 1, "", "schedule_jobs"]], "fossology.license": [[9, 1, 1, "", "LicenseEndpoint"]], "fossology.license.LicenseEndpoint": [[9, 2, 1, "", "add_license"], [9, 2, 1, "", "detail_license"], [9, 2, 1, "", "list_licenses"], [9, 2, 1, "", "update_license"]], "fossology.obj": [[11, 1, 1, "", "Agents"], [11, 1, 1, "", "ApiInfo"], [11, 1, 1, "", "ApiLicense"], [11, 1, 1, "", "File"], [11, 1, 1, "", "FileInfo"], [11, 1, 1, "", "Findings"], [11, 1, 1, "", "Folder"], [11, 1, 1, "", "FossologyServer"], [11, 1, 1, "", "GetBulkHistory"], [11, 1, 1, "", "GetClearingHistory"], [11, 1, 1, "", "GetPrevNextItem"], [11, 1, 1, "", "Group"], [11, 1, 1, "", "Hash"], [11, 1, 1, "", "HealthInfo"], [11, 1, 1, "", "Job"], [11, 1, 1, "", "License"], [11, 1, 1, "", "Obligation"], [11, 1, 1, "", "PermGroups"], [11, 1, 1, "", "SearchResult"], [11, 1, 1, "", "Status"], [11, 1, 1, "", "Summary"], [11, 1, 1, "", "Upload"], [11, 1, 1, "", "UploadCopyrights"], [11, 1, 1, "", "UploadLicenses"], [11, 1, 1, "", "UploadPermGroups"], [11, 1, 1, "", "User"], [11, 1, 1, "", "UserGroupMember"]], "fossology.obj.Agents": [[11, 2, 1, "", "to_dict"], [11, 2, 1, "", "to_json"]], "fossology.obj.License": [[11, 2, 1, "", "to_dict"], [11, 2, 1, "", "to_json"]], "fossology.report": [[12, 1, 1, "", "Report"]], "fossology.report.Report": [[12, 2, 1, "", "download_report"], [12, 2, 1, "", "generate_report"]], "fossology.uploads": [[14, 1, 1, "", "Uploads"], [14, 4, 1, "", "list_uploads_parameters"]], "fossology.uploads.Uploads": [[14, 2, 1, "", "change_upload_permissions"], [14, 2, 1, "", "delete_upload"], [14, 2, 1, "", "detail_upload"], [14, 2, 1, "", "download_upload"], [14, 2, 1, "", "list_uploads"], [14, 2, 1, "", "move_upload"], [14, 2, 1, "", "update_upload"], [14, 2, 1, "", "upload_copyrights"], [14, 2, 1, "", "upload_file"], [14, 2, 1, "", "upload_licenses"], [14, 2, 1, "", "upload_permissions"], [14, 2, 1, "", "upload_summary"]], "fossology.users": [[15, 1, 1, "", "Users"]], "fossology.users.Users": [[15, 2, 1, "", "create_user"], [15, 2, 1, "", "delete_user"], [15, 2, 1, "", "detail_user"], [15, 2, 1, "", "list_users"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"]}, "titleterms": {"fossologi": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15], "enum": 0, "except": 1, "folder": [2, 13], "foss": 3, "cli": [3, 6], "group": [5, 13], "welcom": 6, "": 6, "document": 6, "usag": 6, "instal": 6, "us": 6, "api": 6, "contribut": 6, "develop": 6, "build": 6, "tag": 6, "test": 6, "item": 7, "job": [8, 13], "licens": 9, "log": 10, "object": 11, "report": [12, 13], "sampl": 13, "workflow": 13, "need": 13, "import": 13, "variabl": 13, "creat": 13, "jwt": 13, "token": 13, "login": 13, "server": 13, "If": 13, "upload": [13, 14], "file": 13, "start": 13, "default": 13, "scan": 13, "gener": 13, "delet": 13, "clean": 13, "up": 13, "user": 15}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Fossology Enums": [[0, "fossology-enums"]], "Fossology exceptions": [[1, "fossology-exceptions"]], "Fossology Folders": [[2, "fossology-folders"]], "Foss CLI": [[3, "foss-cli"]], "Fossology": [[4, "fossology"]], "Fossology Groups": [[5, "fossology-groups"]], "Welcome to fossology\u2019s documentation!": [[6, "welcome-to-fossology-s-documentation"]], "Documentation": [[6, "documentation"]], "Usage": [[6, "usage"]], "Installation": [[6, "installation"]], "Using the API": [[6, "using-the-api"]], "Using the CLI": [[6, "using-the-cli"]], "Contribute": [[6, "contribute"]], "Develop": [[6, "develop"]], "Build": [[6, "build"]], "Tag": [[6, "tag"]], "Test": [[6, "test"]], "Fossology Items": [[7, "fossology-items"]], "Fossology Jobs": [[8, "fossology-jobs"]], "Fossology License": [[9, "fossology-license"]], "Logging": [[10, "logging"]], "Fossology objects": [[11, "fossology-objects"]], "Fossology Report": [[12, "fossology-report"]], "Sample Workflow": [[13, "sample-workflow"]], "Needed imports and Variables": [[13, "needed-imports-and-variables"]], "Create JWT Token": [[13, "create-jwt-token"]], "Login to the Fossology Server": [[13, "login-to-the-fossology-server"]], "Create Folder If needed": [[13, "create-folder-if-needed"]], "Create Group If needed": [[13, "create-group-if-needed"]], "Upload File": [[13, "upload-file"]], "Start default scan jobs": [[13, "start-default-scan-jobs"]], "Generate report": [[13, "generate-report"]], "Delete folder": [[13, "delete-folder"]], "Clean up": [[13, "clean-up"]], "Fossology Uploads": [[14, "fossology-uploads"]], "Fossology Users": [[15, "fossology-users"]]}, "indexentries": {"accesslevel (class in fossology.enums)": [[0, "fossology.enums.AccessLevel"]], "clearingscope (class in fossology.enums)": [[0, "fossology.enums.ClearingScope"]], "clearingstatus (class in fossology.enums)": [[0, "fossology.enums.ClearingStatus"]], "clearingtype (class in fossology.enums)": [[0, "fossology.enums.ClearingType"]], "copyrightstatus (class in fossology.enums)": [[0, "fossology.enums.CopyrightStatus"]], "jobstatus (class in fossology.enums)": [[0, "fossology.enums.JobStatus"]], "licensetype (class in fossology.enums)": [[0, "fossology.enums.LicenseType"]], "memberperm (class in fossology.enums)": [[0, "fossology.enums.MemberPerm"]], "obligationclass (class in fossology.enums)": [[0, "fossology.enums.ObligationClass"]], "permission (class in fossology.enums)": [[0, "fossology.enums.Permission"]], "prevnextselection (class in fossology.enums)": [[0, "fossology.enums.PrevNextSelection"]], "reportformat (class in fossology.enums)": [[0, "fossology.enums.ReportFormat"]], "searchtypes (class in fossology.enums)": [[0, "fossology.enums.SearchTypes"]], "tokenscope (class in fossology.enums)": [[0, "fossology.enums.TokenScope"]], "fossology.enums": [[0, "module-fossology.enums"]], "module": [[0, "module-fossology.enums"], [1, "module-fossology.exceptions"], [2, "module-fossology.folders"], [3, "module-fossology.foss_cli"], [4, "module-fossology"], [5, "module-fossology.groups"], [7, "module-fossology.items"], [8, "module-fossology.jobs"], [9, "module-fossology.license"], [11, "module-fossology.obj"], [12, "module-fossology.report"], [14, "module-fossology.uploads"], [15, "module-fossology.users"]], "authenticationerror": [[1, "fossology.exceptions.AuthenticationError"]], "authorizationerror": [[1, "fossology.exceptions.AuthorizationError"]], "error": [[1, "fossology.exceptions.Error"]], "fossologyapierror": [[1, "fossology.exceptions.FossologyApiError"]], "fossologyunsupported": [[1, "fossology.exceptions.FossologyUnsupported"]], "fossology.exceptions": [[1, "module-fossology.exceptions"]], "folders (class in fossology.folders)": [[2, "fossology.folders.Folders"]], "copy_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.copy_folder"]], "create_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.create_folder"]], "delete_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.delete_folder"]], "detail_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.detail_folder"]], "fossology.folders": [[2, "module-fossology.folders"]], "list_folders() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.list_folders"]], "move_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.move_folder"]], "update_folder() (fossology.folders.folders method)": [[2, "fossology.folders.Folders.update_folder"]], "check_get_access_level() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.check_get_access_level"]], "check_get_folder() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.check_get_folder"]], "check_get_report_format() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.check_get_report_format"]], "fossology.foss_cli": [[3, "module-fossology.foss_cli"]], "get_newest_upload_of_file() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.get_newest_upload_of_file"]], "init_foss() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.init_foss"]], "needs_later_initialization_of_foss_instance() (in module fossology.foss_cli)": [[3, "fossology.foss_cli.needs_later_initialization_of_foss_instance"]], "fossology (class in fossology)": [[4, "fossology.Fossology"]], "fossology": [[4, "module-fossology"]], "fossology_token() (in module fossology)": [[4, "fossology.fossology_token"]], "get_health() (fossology.fossology method)": [[4, "fossology.Fossology.get_health"]], "get_info() (fossology.fossology method)": [[4, "fossology.Fossology.get_info"]], "get_self() (fossology.fossology method)": [[4, "fossology.Fossology.get_self"]], "groups (class in fossology.groups)": [[5, "fossology.groups.Groups"]], "add_group_member() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.add_group_member"]], "create_group() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.create_group"]], "delete_group() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.delete_group"]], "delete_group_member() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.delete_group_member"]], "fossology.groups": [[5, "module-fossology.groups"]], "list_group_members() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.list_group_members"]], "list_groups() (fossology.groups.groups method)": [[5, "fossology.groups.Groups.list_groups"]], "items (class in fossology.items)": [[7, "fossology.items.Items"]], "fossology.items": [[7, "module-fossology.items"]], "get_bulk_history() (fossology.items.items method)": [[7, "fossology.items.Items.get_bulk_history"]], "get_clearing_history() (fossology.items.items method)": [[7, "fossology.items.Items.get_clearing_history"]], "get_prev_next() (fossology.items.items method)": [[7, "fossology.items.Items.get_prev_next"]], "item_copyrights() (fossology.items.items method)": [[7, "fossology.items.Items.item_copyrights"]], "item_info() (fossology.items.items method)": [[7, "fossology.items.Items.item_info"]], "schedule_bulk_scan() (fossology.items.items method)": [[7, "fossology.items.Items.schedule_bulk_scan"]], "jobs (class in fossology.jobs)": [[8, "fossology.jobs.Jobs"]], "detail_job() (fossology.jobs.jobs method)": [[8, "fossology.jobs.Jobs.detail_job"]], "fossology.jobs": [[8, "module-fossology.jobs"]], "list_jobs() (fossology.jobs.jobs method)": [[8, "fossology.jobs.Jobs.list_jobs"]], "schedule_jobs() (fossology.jobs.jobs method)": [[8, "fossology.jobs.Jobs.schedule_jobs"]], "licenseendpoint (class in fossology.license)": [[9, "fossology.license.LicenseEndpoint"]], "add_license() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.add_license"]], "detail_license() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.detail_license"]], "fossology.license": [[9, "module-fossology.license"]], "list_licenses() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.list_licenses"]], "update_license() (fossology.license.licenseendpoint method)": [[9, "fossology.license.LicenseEndpoint.update_license"]], "agents (class in fossology.obj)": [[11, "fossology.obj.Agents"]], "apiinfo (class in fossology.obj)": [[11, "fossology.obj.ApiInfo"]], "apilicense (class in fossology.obj)": [[11, "fossology.obj.ApiLicense"]], "file (class in fossology.obj)": [[11, "fossology.obj.File"]], "fileinfo (class in fossology.obj)": [[11, "fossology.obj.FileInfo"]], "findings (class in fossology.obj)": [[11, "fossology.obj.Findings"]], "folder (class in fossology.obj)": [[11, "fossology.obj.Folder"]], "fossologyserver (class in fossology.obj)": [[11, "fossology.obj.FossologyServer"]], "getbulkhistory (class in fossology.obj)": [[11, "fossology.obj.GetBulkHistory"]], "getclearinghistory (class in fossology.obj)": [[11, "fossology.obj.GetClearingHistory"]], "getprevnextitem (class in fossology.obj)": [[11, "fossology.obj.GetPrevNextItem"]], "group (class in fossology.obj)": [[11, "fossology.obj.Group"]], "hash (class in fossology.obj)": [[11, "fossology.obj.Hash"]], "healthinfo (class in fossology.obj)": [[11, "fossology.obj.HealthInfo"]], "job (class in fossology.obj)": [[11, "fossology.obj.Job"]], "license (class in fossology.obj)": [[11, "fossology.obj.License"]], "obligation (class in fossology.obj)": [[11, "fossology.obj.Obligation"]], "permgroups (class in fossology.obj)": [[11, "fossology.obj.PermGroups"]], "searchresult (class in fossology.obj)": [[11, "fossology.obj.SearchResult"]], "status (class in fossology.obj)": [[11, "fossology.obj.Status"]], "summary (class in fossology.obj)": [[11, "fossology.obj.Summary"]], "upload (class in fossology.obj)": [[11, "fossology.obj.Upload"]], "uploadcopyrights (class in fossology.obj)": [[11, "fossology.obj.UploadCopyrights"]], "uploadlicenses (class in fossology.obj)": [[11, "fossology.obj.UploadLicenses"]], "uploadpermgroups (class in fossology.obj)": [[11, "fossology.obj.UploadPermGroups"]], "user (class in fossology.obj)": [[11, "fossology.obj.User"]], "usergroupmember (class in fossology.obj)": [[11, "fossology.obj.UserGroupMember"]], "fossology.obj": [[11, "module-fossology.obj"]], "to_dict() (fossology.obj.agents method)": [[11, "fossology.obj.Agents.to_dict"]], "to_dict() (fossology.obj.license method)": [[11, "fossology.obj.License.to_dict"]], "to_json() (fossology.obj.agents method)": [[11, "fossology.obj.Agents.to_json"]], "to_json() (fossology.obj.license method)": [[11, "fossology.obj.License.to_json"]], "report (class in fossology.report)": [[12, "fossology.report.Report"]], "download_report() (fossology.report.report method)": [[12, "fossology.report.Report.download_report"]], "fossology.report": [[12, "module-fossology.report"]], "generate_report() (fossology.report.report method)": [[12, "fossology.report.Report.generate_report"]], "uploads (class in fossology.uploads)": [[14, "fossology.uploads.Uploads"]], "change_upload_permissions() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.change_upload_permissions"]], "delete_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.delete_upload"]], "detail_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.detail_upload"]], "download_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.download_upload"]], "fossology.uploads": [[14, "module-fossology.uploads"]], "list_uploads() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.list_uploads"]], "list_uploads_parameters() (in module fossology.uploads)": [[14, "fossology.uploads.list_uploads_parameters"]], "move_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.move_upload"]], "update_upload() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.update_upload"]], "upload_copyrights() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_copyrights"]], "upload_file() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_file"]], "upload_licenses() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_licenses"]], "upload_permissions() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_permissions"]], "upload_summary() (fossology.uploads.uploads method)": [[14, "fossology.uploads.Uploads.upload_summary"]], "users (class in fossology.users)": [[15, "fossology.users.Users"]], "create_user() (fossology.users.users method)": [[15, "fossology.users.Users.create_user"]], "delete_user() (fossology.users.users method)": [[15, "fossology.users.Users.delete_user"]], "detail_user() (fossology.users.users method)": [[15, "fossology.users.Users.detail_user"]], "fossology.users": [[15, "module-fossology.users"]], "list_users() (fossology.users.users method)": [[15, "fossology.users.Users.list_users"]]}}) \ No newline at end of file diff --git a/uploads.html b/uploads.html index 785c3da..5d5a84e 100644 --- a/uploads.html +++ b/uploads.html @@ -525,7 +525,7 @@

    Fossology Uploads
    -fossology.uploads.list_uploads_parameters(folder: Folder | None = None, recursive: bool = True, name: str | None = None, status: ClearingStatus | None = None, assignee: str | None = None, since: str | None = None) → dict
    +fossology.uploads.list_uploads_parameters(folder: Folder | None = None, recursive: bool = True, name: str | None = None, status: ClearingStatus | None = None, assignee: str | None = None, since: str | None = None, group: str | None = None, limit: str | None = None) → dict

    Helper function to list of query parameters for GET /uploads endpoint