synapse 2.223.0__py311-none-any.whl → 2.225.0__py311-none-any.whl

synapse/tools/healthcheck.py

@@ -1,109 +1,11 @@
-import socket
-import asyncio
-
-import synapse.exc as s_exc
 import synapse.common as s_common
-import synapse.telepath as s_telepath
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.json as s_json
-import synapse.lib.output as s_output
-import synapse.lib.health as s_health
-import synapse.lib.urlhelp as s_urlhelp
-
-def serialize(ret):
-    return s_json.dumps(ret).decode()
-
-def format_component(e, mesg: str) -> dict:
-    d = {
-        'name': 'error',
-        'status': s_health.FAILED,
-        'mesg': mesg,
-        'data': {
-            'errname': e.__class__.__name__,
-            'errmesg': str(e),
-        }
-    }
-
-    return d
-
-async def main(argv, outp=s_output.stdout):
-    pars = getArgParser(outp)
-    try:
-        opts = pars.parse_args(argv)
-    except s_exc.ParserExit as e:  # pragma: no cover
-        return e.get('status')
-
-    url = opts.cell
-    sanitized_url = s_urlhelp.sanitizeUrl(url)
-
-    try:
-        async with s_telepath.withTeleEnv():
-
-            prox = await s_common.wait_for(s_telepath.openurl(url),
-                                           timeout=opts.timeout)
-    except (s_exc.LinkErr, s_exc.NoSuchPath, socket.gaierror) as e:
-        mesg = f'Unable to connect to cell @ {sanitized_url}.'
-        ret = {'status': 'failed',
-               'iden': opts.cell,
-               'components': [format_component(e, mesg)],
-               }
-        outp.printf(serialize(ret))
-        return 1
-    except s_exc.SynErr as e:
-        mesg = 'Synapse error encountered.'
-        ret = {'status': s_health.FAILED,
-               'iden': opts.cell,
-               'components': [format_component(e, mesg)],
-               }
-        outp.printf(serialize(ret))
-        return 1
-    except asyncio.TimeoutError as e:  # pragma: no cover
-        mesg = 'Timeout connecting to cell'
-        ret = {'status': s_health.FAILED,
-               'iden': opts.cell,
-               'components': [format_component(e, mesg)],
-               }
-        outp.printf(serialize(ret))
-        return 1
-
-    try:
-        ret = await s_common.wait_for(prox.getHealthCheck(),
-                                      timeout=opts.timeout)
-    except s_exc.SynErr as e:
-        mesg = 'Synapse error encountered.'
-        ret = {'status': s_health.FAILED,
-               'iden': opts.cell,
-               'components': [format_component(e, mesg)],
-               }
-
-    except asyncio.TimeoutError as e:
-        mesg = 'Timeout getting health information from cell.'
-        ret = {'status': s_health.FAILED,
-               'iden': opts.cell,
-               'components': [format_component(e, mesg)],
-               }
-
-    finally:
-        await prox.fini()
-
-    retval = 1
-    if ret.get('status') in (s_health.NOMINAL, s_health.DEGRADED):
-        retval = 0
 
-    outp.printf(serialize(ret))
-    return retval
+from synapse.tools.service.healthcheck import main
 
-def getArgParser(outp):
-    desc = '''
-    synapse healthcheck tool
-    '''
-    pars = s_cmd.Parser(prog='synapse.tools.healthcheck', outp=outp, description=desc)
-    pars.add_argument('--cell', '-c', required=True, type=str,
-                      help='Telepath path to the cell to check.')
-    pars.add_argument('--timeout', '-t', default=10, type=float,
-                      help='Connection and call timeout')
-    return pars
+s_common.deprecated('synapse.tools.healthcheck is deprecated. Please use synapse.tools.service.healthcheck instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
     s_cmd.exitmain(main)

synapse/tools/json2mpk.py

@@ -1,43 +1,11 @@
-import os
-import sys
-import argparse
+import synapse.common as s_common
 
-import synapse.lib.json as s_json
-import synapse.lib.output as s_output
-import synapse.lib.msgpack as s_msgpack
+import synapse.lib.cmd as s_cmd
 
-def getArgParser():
-    pars = argparse.ArgumentParser(description='Convert files from json lines to msgpack')
-    pars.add_argument('--rm', action='store_true', help='Remove json files once the conversion is complete')
-    pars.add_argument('paths', nargs='+', help='json files or directories full of json files')
-    return pars
+from synapse.tools.utils.json2mpk import main
 
-def main(argv, outp=s_output.stdout):
-    pars = getArgParser()
-    opts = pars.parse_args(argv)
-
-    for path in opts.paths:
-
-        if not path.endswith('.json'):
-            outp.printf('skip: %s (not .json extension)' % (path,))
-            continue
-
-        if not os.path.isfile(path):
-            outp.printf('skip: %s (not a file)' % (path,))
-            continue
-
-        base = path[:-5]
-        newp = base + '.mpk'
-
-        outp.printf('converting: %s -> .mpk' % (path,))
-        with open(path, 'r', encoding='utf8') as fd:
-            with open(newp, 'wb') as pk:
-                for line in fd:
-                    item = s_json.loads(line)
-                    pk.write(s_msgpack.en(item))
-
-        if opts.rm:
-            os.unlink(path)
+s_common.deprecated('synapse.tools.json2mpk is deprecated. Please use synapse.tools.utils.json2mpk instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
-    sys.exit(main(sys.argv[1:]))
+    s_cmd.exitmain(main)

synapse/tools/livebackup.py

@@ -1,34 +1,11 @@
-import synapse.telepath as s_telepath
+import synapse.common as s_common
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.output as s_output
 
-descr = '''
-Generate a new backup of a running Synapse service.
+from synapse.tools.service.livebackup import main
 
-Examples:
-
-    # Generate a backup from inside a Synapse service container
-    python -m synapse.tools.livebackup
-
-'''
-
-async def main(argv, outp=s_output.stdout):
-
-    pars = s_cmd.Parser(prog='synapse.tools.livebackup', outp=outp, description=descr)
-
-    pars.add_argument('--url', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
-    pars.add_argument('--name', default=None, help='Specify a name for the backup.  Defaults to an automatically generated timestamp.')
-
-    opts = pars.parse_args(argv)
-
-    async with s_telepath.withTeleEnv():
-
-        async with await s_telepath.openurl(opts.url) as cell:
-            outp.printf(f'Running backup of: {opts.url}')
-            name = await cell.runBackup(name=opts.name)
-            outp.printf(f'...backup created: {name}')
-    return 0
+s_common.deprecated('synapse.tools.livebackup is deprecated. Please use synapse.tools.service.livebackup instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
     s_cmd.exitmain(main)

synapse/tools/modrole.py

@@ -1,116 +1,11 @@
 import synapse.common as s_common
-import synapse.telepath as s_telepath
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.output as s_output
 
-descr = '''
-Add or modify a role in a Synapse service.
-'''
+from synapse.tools.service.modrole import main
 
-def printrole(role, outp):
-
-    outp.printf(f'Role: {role.get("name")} ({role.get("iden")})')
-    outp.printf('')
-    outp.printf('  Rules:')
-    for indx, rule in enumerate(role.get('rules')):
-        outp.printf(f'    [{str(indx).ljust(3)}] - {s_common.reprauthrule(rule)}')
-
-    outp.printf('')
-    outp.printf('  Gates:')
-    for gateiden, gateinfo in role.get('authgates', {}).items():
-        outp.printf(f'    {gateiden}')
-        outp.printf(f'      Admin: {gateinfo.get("admin") == True}')
-        for indx, rule in enumerate(gateinfo.get('rules', ())):
-            outp.printf(f'      [{str(indx).ljust(3)}] - {s_common.reprauthrule(rule)}')
-
-async def main(argv, outp=s_output.stdout):
-
-    pars = s_cmd.Parser(prog='synapse.tools.modrole', outp=outp, description=descr)
-    pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
-    pars.add_argument('--add', default=False, action='store_true', help='Add the role if they do not already exist.')
-    pars.add_argument('--del', dest='delete', default=False, action='store_true', help='Delete the role if it exists.')
-    pars.add_argument('--list', default=False, action='store_true',
-                      help='List existing roles, or rules of a specific role.')
-    pars.add_argument('--allow', default=[], action='append', help='A permission string to allow for the role.')
-    pars.add_argument('--deny', default=[], action='append', help='A permission string to deny for the role.')
-    pars.add_argument('--gate', default=None, help='The iden of an auth gate to add/del rules on.')
-    pars.add_argument('rolename', nargs='?', help='The rolename to add/edit.')
-
-    opts = pars.parse_args(argv)
-
-    if opts.add and opts.delete:
-        outp.printf('ERROR: Cannot specify --add and --del together.')
-        return 1
-
-    async with s_telepath.withTeleEnv():
-
-        async with await s_telepath.openurl(opts.svcurl) as cell:
-
-            if opts.list:
-                if opts.rolename:
-                    role = await cell.getRoleDefByName(opts.rolename)
-                    if role is None:
-                        outp.printf(f'ERROR: Role not found: {opts.rolename}')
-                        return 1
-
-                    printrole(role, outp)
-
-                else:
-                    outp.printf('Roles:')
-                    for role in await cell.getRoleDefs():
-                        outp.printf(f'  {role.get("iden")} - {role.get("name")}')
-
-                return 0
-            elif opts.rolename is None:
-                outp.printf(f'ERROR: A rolename argument is required when --list is not specified.')
-                return 1
-
-            if opts.gate:
-                gate = await cell.getAuthGate(opts.gate)
-                if gate is None:
-                    outp.printf(f'ERROR: No auth gate found with iden: {opts.gate}')
-                    return 1
-
-            role = await cell.getRoleDefByName(opts.rolename)
-            if role is not None:
-                outp.printf(f'Modifying role: {opts.rolename}')
-
-            if role is None:
-                if not opts.add:
-                    outp.printf(f'ERROR: Role not found (need --add?): {opts.rolename}')
-                    return 1
-
-                outp.printf(f'Adding role: {opts.rolename}')
-                role = await cell.addRole(opts.rolename)
-
-            roleiden = role.get('iden')
-
-            if opts.delete:
-                outp.printf(f'...deleting role: {opts.rolename}')
-                await cell.delRole(roleiden)
-                return 0
-
-            for allow in opts.allow:
-                perm = allow.lower().split('.')
-                mesg = f'...adding allow rule: {allow}'
-                if opts.gate:
-                    mesg += f' on gate {opts.gate}'
-
-                outp.printf(mesg)
-                if not await cell.isRoleAllowed(roleiden, perm, gateiden=opts.gate):
-                    await cell.addRoleRule(roleiden, (True, perm), indx=0, gateiden=opts.gate)
-
-            for deny in opts.deny:
-                perm = deny.lower().split('.')
-                mesg = f'...adding deny rule: {deny}'
-                if opts.gate:
-                    mesg += f' on gate {opts.gate}'
-
-                outp.printf(mesg)
-                if await cell.isRoleAllowed(roleiden, perm, gateiden=opts.gate):
-                    await cell.addRoleRule(roleiden, (False, perm), indx=0, gateiden=opts.gate)
-    return 0
+s_common.deprecated('synapse.tools.modrole is deprecated. Please use synapse.tools.service.modrole instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
     s_cmd.exitmain(main)

synapse/tools/moduser.py

@@ -1,187 +1,11 @@
 import synapse.common as s_common
-import synapse.telepath as s_telepath
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.output as s_output
 
-descr = '''
-Add, modify, or list users of a Synapse service.
-'''
+from synapse.tools.service.moduser import main
 
-def printuser(user, outp):
-
-    admin = user.get('admin')
-    authtype = user.get('type')
-
-    outp.printf(f'User: {user.get("name")} ({user.get("iden")})')
-    outp.printf('')
-    outp.printf(f'  Locked: {user.get("locked")}')
-    outp.printf(f'  Admin: {user.get("admin")}')
-    outp.printf(f'  Email: {user.get("email")}')
-    outp.printf('  Rules:')
-    for indx, rule in enumerate(user.get('rules')):
-        outp.printf(f'    [{str(indx).ljust(3)}] - {s_common.reprauthrule(rule)}')
-
-    outp.printf('')
-    outp.printf('  Roles:')
-    for role in user.get('roles'):
-        outp.printf(f'    {role.get("iden")} - {role.get("name")}')
-
-    outp.printf('')
-    outp.printf('  Gates:')
-    for gateiden, gateinfo in user.get('authgates', {}).items():
-        outp.printf(f'    {gateiden}')
-        outp.printf(f'      Admin: {gateinfo.get("admin") == True}')
-        for indx, rule in enumerate(gateinfo.get('rules', ())):
-            outp.printf(f'      [{str(indx).ljust(3)}] - {s_common.reprauthrule(rule)}')
-
-async def main(argv, outp=s_output.stdout):
-
-    pars = s_cmd.Parser(prog='synapse.tools.moduser', outp=outp, description=descr)
-    pars.add_argument('--svcurl', default='cell:///vertex/storage', help='The telepath URL of the Synapse service.')
-    pars.add_argument('--add', default=False, action='store_true', help='Add the user if they do not already exist.')
-    pars.add_argument('--del', dest='delete', default=False, action='store_true', help='Delete the user if they exist.')
-    pars.add_argument('--list', default=False, action='store_true',
-                      help='List existing users of the service, or details of a specific user.')
-    pars.add_argument('--admin', choices=('true', 'false'), default=None, help='Set the user admin status.')
-    pars.add_argument('--passwd', action='store', type=str, help='A password to set for the user.')
-    pars.add_argument('--email', action='store', type=str, help='An email to set for the user.')
-    pars.add_argument('--locked', choices=('true', 'false'), default=None, help='Set the user locked status.')
-    pars.add_argument('--grant', default=[], action='append', help='A role to grant to the user.')
-    pars.add_argument('--revoke', default=[], action='append', help='A role to revoke from the user.')
-    pars.add_argument('--allow', default=[], action='append', help='A permission string to allow for the user.')
-    pars.add_argument('--deny', default=[], action='append', help='A permission string to deny for the user.')
-    pars.add_argument('--gate', default=None, help='The iden of an auth gate to add/del rules or set admin status on.')
-    pars.add_argument('username', nargs='?', help='The username to add/edit or show details.')
-
-    opts = pars.parse_args(argv)
-
-    if opts.add and opts.delete:
-        outp.printf('ERROR: Cannot specify --add and --del together.')
-        return 1
-
-    async with s_telepath.withTeleEnv():
-
-        async with await s_telepath.openurl(opts.svcurl) as cell:
-
-            if opts.list:
-                if opts.username:
-                    user = await cell.getUserDefByName(opts.username)
-                    if user is None:
-                        outp.printf(f'ERROR: User not found: {opts.username}')
-                        return 1
-
-                    printuser(user, outp)
-
-                else:
-                    outp.printf('Users:')
-                    for user in await cell.getUserDefs():
-                        outp.printf(f'  {user.get("name")}')
-
-                return 0
-
-            elif opts.username is None:
-                outp.printf(f'ERROR: A username argument is required when --list is not specified.')
-                return 1
-
-            if opts.gate:
-                gate = await cell.getAuthGate(opts.gate)
-                if gate is None:
-                    outp.printf(f'ERROR: No auth gate found with iden: {opts.gate}')
-                    return 1
-
-            grants = []
-            revokes = []
-
-            for rolename in opts.grant:
-                role = await cell.getRoleDefByName(rolename)
-                if role is None:
-                    outp.printf(f'ERROR: Role not found: {rolename}')
-                    return 1
-                grants.append(role)
-
-            for rolename in opts.revoke:
-                role = await cell.getRoleDefByName(rolename)
-                if role is None:
-                    outp.printf(f'ERROR: Role not found: {rolename}')
-                    return 1
-                revokes.append(role)
-
-            user = await cell.getUserDefByName(opts.username)
-
-            if user is None:
-                if not opts.add:
-                    outp.printf(f'ERROR: User not found (need --add?): {opts.username}')
-                    return 1
-
-                outp.printf(f'Adding user: {opts.username}')
-                user = await cell.addUser(opts.username)
-
-            else:
-                outp.printf(f'Modifying user: {opts.username}')
-
-            useriden = user.get('iden')
-            if not s_common.isguid(useriden):  # pragma: no cover
-                outp.printf(f'ERROR: Invalid useriden: {useriden}')
-                return 1
-
-            if opts.delete:
-                outp.printf(f'...deleting user: {opts.username}')
-                await cell.delUser(useriden)
-                return 0
-
-            if opts.admin is not None:
-                admin = s_common.yamlloads(opts.admin)
-                mesg = f'...setting admin: {opts.admin}'
-                if opts.gate:
-                    mesg += f' on gate {opts.gate}'
-
-                outp.printf(mesg)
-                await cell.setUserAdmin(useriden, admin, gateiden=opts.gate)
-
-            if opts.locked is not None:
-                locked = s_common.yamlloads(opts.locked)
-                outp.printf(f'...setting locked: {opts.locked}')
-                await cell.setUserLocked(useriden, locked)
-
-            if opts.passwd is not None:
-                outp.printf(f'...setting passwd: {opts.passwd}')
-                await cell.setUserPasswd(useriden, opts.passwd)
-
-            if opts.email is not None:
-                outp.printf(f'...setting email: {opts.email}')
-                await cell.setUserEmail(useriden, opts.email)
-
-            for role in grants:
-                rolename = role.get('name')
-                outp.printf(f'...granting role: {rolename}')
-                await cell.addUserRole(useriden, role.get('iden'))
-
-            for role in revokes:
-                rolename = role.get('name')
-                outp.printf(f'...revoking role: {rolename}')
-                await cell.delUserRole(useriden, role.get('iden'))
-
-            for allow in opts.allow:
-                perm = allow.lower().split('.')
-                mesg = f'...adding allow rule: {allow}'
-                if opts.gate:
-                    mesg += f' on gate {opts.gate}'
-
-                outp.printf(mesg)
-                if not await cell.isUserAllowed(useriden, perm, gateiden=opts.gate):
-                    await cell.addUserRule(useriden, (True, perm), indx=0, gateiden=opts.gate)
-
-            for deny in opts.deny:
-                perm = deny.lower().split('.')
-                mesg = f'...adding deny rule: {deny}'
-                if opts.gate:
-                    mesg += f' on gate {opts.gate}'
-
-                outp.printf(mesg)
-                if await cell.isUserAllowed(useriden, perm, gateiden=opts.gate):
-                    await cell.addUserRule(useriden, (False, perm), indx=0, gateiden=opts.gate)
-    return 0
+s_common.deprecated('synapse.tools.moduser is deprecated. Please use synapse.tools.service.moduser instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
     s_cmd.exitmain(main)

synapse/tools/pkgs/gendocs.py

@@ -1,174 +1,13 @@
-import os
-import shutil
 import logging
-import subprocess
 
-import regex as re
-
-import synapse.exc as s_exc
 import synapse.common as s_common
 
 import synapse.lib.cmd as s_cmd
-import synapse.lib.output as s_output
-
-import synapse.tools.rstorm as s_rstorm
-import synapse.tools.autodoc as s_autodoc
-
-logger = logging.getLogger(__name__)
-
-_TOOLDIR = os.path.split(__file__)[0]
-PANDOC_FILTER = os.path.join(_TOOLDIR, 'pandoc_filter.py')
-
-# see https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#file-wide-metadata
-re_sphinx_metadata_fields = re.compile(r'^:(tocdepth|nocomments|orphan|nosearch):( \w+)?\n\n',
-                                       flags=re.MULTILINE)
-
-def hasPandoc():
-    if os.system('pandoc --version') == 0:
-        return True
-    return False
-
-async def buildPkgDocs(outp, pkgpath: str, rst_only: bool =False):
-
-    logger.info(f'Building pkg for {pkgpath}')
-    pkgdef = s_common.yamlload(pkgpath)
-    if pkgdef is None:
-        raise s_exc.BadArg(mesg=f'Package does not exist or does not contain yaml: {pkgpath}')
-
-    dirn = os.path.dirname(s_common.genpath(pkgpath))
-
-    docsdir = os.path.join(dirn, 'docs')
-    builddir = os.path.join(dirn, 'docs', '_build')
-
-    shutil.rmtree(builddir, ignore_errors=True)
-
-    s_common.gendir(builddir)
-
-    # touch any files we need in order to load a package, due to
-    # rstorm needing to load the package using genpkg tool. This
-    # does mean that standalone builds of a storm package from this
-    # must be done after using this buildpkg tool.
-    stormpkg_md_present = False
-    for dnfo in pkgdef.get('docs', ()):
-        fpath = dnfo.get('path')
-        with s_common.genfile(dirn, fpath) as fd:
-            pass
-        if fpath.endswith('stormpackage.md'):
-            stormpkg_md_present = True
-
-    # Generate the build .RST for stormpackage.md
-    if stormpkg_md_present:
-        logger.info(f'Generating stormpackage.rst for {pkgpath}')
-        pkgdocs, pkgname = await s_autodoc.docStormpkg(pkgpath)
-        with s_common.genfile(docsdir, 'stormpackage.rst') as fd:
-            text = pkgdocs.getRstText()
-            if rst_only is False:
-                # Leave this in place if we're only generating RST
-                text = text.replace('.. highlight:: none\n', '')
-            fd.write(text.encode())
-        logger.info('Generated the stormpackage.rst file!')
-
-    for name in os.listdir(docsdir):
-
-        if not name.endswith('.rst'):
-            continue
-
-        docpath = os.path.join(docsdir, name)
-
-        basename = name.rsplit('.', 1)[0]
-
-        builtmd = os.path.join(builddir, f'{basename}.md')
-        builtrst = os.path.join(builddir, name)
-
-        argv = (docpath, '--save', builtrst)
-        logger.info(f'Executing rstorm for {argv}')
-        await s_rstorm.main(argv)
-
-        if rst_only:
-            logger.info(f'rst_only enabled, done processing {name}')
-            continue
-
-        logger.info('Preprocessing rstorm output')
-        with s_common.genfile(builtrst) as fd:
-            buf = fd.read().decode()
-
-        # Remove highglight:: none directives
-        buf = buf.replace('.. highlight:: none\n', '')
-
-        # Remove sphinx metadata fields
-        buf = re_sphinx_metadata_fields.sub('', buf)
-
-        lines = buf.splitlines(keepends=True)
-
-        # Remove lines which start with explicit sphinx rst targets
-        nlines1 = []
-        for line in lines:
-            if line.startswith('.. _') and line.strip().endswith(':'):
-                logger.info(f'Dropping: [{line.strip()}]')
-                continue
-            nlines1.append(line)
-
-        buf = ''.join(nlines1)
-
-        with s_common.genfile(builtrst) as fd:
-            fd.truncate()
-            _ = fd.write(buf.encode())
-
-        logger.info(f'Converting {builtrst} to markdown')
-        if name == 'stormpackage.rst':
-            args = ['pandoc', '--filter', PANDOC_FILTER, '-f', 'rst', '-t', 'markdown', '-o', builtmd, builtrst]
-        else:
-            args = ['pandoc', '-f', 'rst', '-t', 'markdown', '-o', builtmd, builtrst]
-
-        r = subprocess.run(args, capture_output=True)
-
-        # Re-write stderr (logging) to our outp
-        for line in r.stderr.decode().splitlines():
-            outp.printf(f'ERR: {line}')
-
-        if r.returncode != 0:
-            raise s_exc.SynErr(mesg=f'Error converting {builtrst} to {builtmd}')
-
-        logger.info(f'Done converting {builtrst} to {builtmd}')
-
-        # Strip out / manipulate the md content
-        with s_common.genfile(builtmd) as fd:
-            buf = fd.read().decode()
-
-        lines = buf.splitlines(keepends=True)
-
-        # Remove lines which only have a single `:` left in them
-        nlines1 = [line for line in lines if line.strip() != ':']
-
-        buf = ''.join(nlines1)
-
-        with s_common.genfile(builtmd) as fd:
-            fd.truncate()
-            _ = fd.write(buf.encode())
-
-        logger.info('Done manipulating markdown')
-
-    logger.info(f'buildPkgDocs complete for {pkgpath}.')
-
-prog = 'synapse.tools.pkgs.gendocs'
-desc = 'A tool for building storm package docs from RStorm into markdown. This tool requires pandoc to be available.'
-
-async def main(argv, outp=s_output.stdout):
-
-    pars = s_cmd.Parser(prog=prog, outp=outp, description=desc)
-    pars.add_argument('pkgfile', metavar='<pkgfile>', help='Path to a storm package prototype yml file.')
-    pars.add_argument('--rst-only', default=False, action='store_true',
-                      help='Stops building after the .rst files have been generated.')
-
-    opts = pars.parse_args(argv)
-
-    if opts.rst_only is False and not hasPandoc():
-        logger.error('Pandoc is not available, can only run rst/rstorm output.')
-        return 1
 
-    await buildPkgDocs(outp, opts.pkgfile, rst_only=opts.rst_only)
+from synapse.tools.storm.pkg.doc import logger, main
 
-    return 0
+s_common.deprecated('synapse.tools.pkgs.gendocs is deprecated. Please use synapse.tools.storm.pkg.doc instead.',
+                    curv='v2.225.0')
 
 if __name__ == '__main__':  # pragma: no cover
     s_common.setlogging(logger, 'DEBUG')