Internal API

These pages document the entire internal API

• citelang package
  • Submodules
  • citelang.defaults module
  • citelang.logger module
    • ColorizingStreamHandler
      • ColorizingStreamHandler.BLACK
      • ColorizingStreamHandler.BLUE
      • ColorizingStreamHandler.BOLD_SEQ
      • ColorizingStreamHandler.COLOR_SEQ
      • ColorizingStreamHandler.CYAN
      • ColorizingStreamHandler.GREEN
      • ColorizingStreamHandler.MAGENTA
      • ColorizingStreamHandler.RED
      • ColorizingStreamHandler.RESET_SEQ
      • ColorizingStreamHandler.WHITE
      • ColorizingStreamHandler.YELLOW
      • ColorizingStreamHandler.can_color_tty()
      • ColorizingStreamHandler.colors
      • ColorizingStreamHandler.decorate()
      • ColorizingStreamHandler.emit()
      • ColorizingStreamHandler.is_tty
    • Logger
      • Logger.cleanup()
      • Logger.debug()
      • Logger.error()
      • Logger.exit()
      • Logger.handler()
      • Logger.info()
      • Logger.location()
      • Logger.progress()
      • Logger.set_level()
      • Logger.set_stream_handler()
      • Logger.shellcmd()
      • Logger.text_handler()
      • Logger.warning()
    • setup_logger()
    • spinner()
  • citelang.main module
  • citelang.main.base module
    • BaseClient
      • BaseClient.badge()
      • BaseClient.check_manager()
      • BaseClient.credit()
      • BaseClient.dependencies()
      • BaseClient.graph()
      • BaseClient.package()
      • BaseClient.package_managers()
  • citelang.main.client module
    • get_parser()
  • citelang.main.endpoints module
    • Dependencies
      • Dependencies.dont_truncate
      • Dependencies.emoji
      • Dependencies.format_url
      • Dependencies.name
      • Dependencies.path
      • Dependencies.skips
      • Dependencies.table_data()
    • Endpoint
      • Endpoint.dont_truncate
      • Endpoint.emoji
      • Endpoint.format_params()
      • Endpoint.order()
      • Endpoint.require_params()
      • Endpoint.skip_list
      • Endpoint.table_data()
      • Endpoint.title
      • Endpoint.truncate_list
      • Endpoint.url
    • Package
      • Package.emoji
      • Package.format_url
      • Package.name
      • Package.order()
      • Package.path
      • Package.skips
      • Package.table_data()
      • Package.title
    • PackageManagers
      • PackageManagers.emoji
      • PackageManagers.name
      • PackageManagers.path
      • PackageManagers.skips
      • PackageManagers.table_data()
    • endpoint
    • get_endpoint()
  • citelang.main.package module
    • CustomPackage
      • CustomPackage.dependencies()
      • CustomPackage.homepage
      • CustomPackage.info()
    • Package
      • Package.dependencies()
      • Package.info()
    • PackageBase
      • PackageBase.cache_name
      • PackageBase.dependencies()
      • PackageBase.homepage
      • PackageBase.info()
      • PackageBase.parse()
    • get_package()
  • citelang.main.result module
    • Badge
      • Badge.print_result()
      • Badge.save()
    • Graph
      • Graph.graph()
    • InteractiveBadge
      • InteractiveBadge.print_result()
      • InteractiveBadge.save()
    • Result
      • Result.print_json()
      • Result.save()
      • Result.to_dict()
    • Table
      • Table.available_width()
      • Table.ensure_complete()
      • Table.ensure_complete_list()
      • Table.table()
      • Table.table_columns()
      • Table.table_rows()
    • Tree
      • Tree.parse_data()
      • Tree.print_result()
    • Treemap
      • Treemap.print_result()
      • Treemap.save()
  • citelang.main.schemas module
  • citelang.main.settings module
    • Settings
    • SettingsBase
      • SettingsBase.add()
      • SettingsBase.change_validate()
      • SettingsBase.delete()
      • SettingsBase.edit()
      • SettingsBase.get()
      • SettingsBase.get_settings_file()
      • SettingsBase.inituser()
      • SettingsBase.load()
      • SettingsBase.parse_boolean()
      • SettingsBase.parse_null()
      • SettingsBase.remove()
      • SettingsBase.save()
      • SettingsBase.set()
      • SettingsBase.update_param()
      • SettingsBase.update_params()
      • SettingsBase.validate()
    • init_settings()
  • citelang.main.graph module
  • citelang.main.graph.base module
    • GraphBase
      • GraphBase.generate_placeholder()
      • GraphBase.iter_nodes()
      • GraphBase.outfile
      • GraphBase.parse()
  • citelang.main.graph.cypher module
    • Cypher
      • Cypher.generate()
  • citelang.main.graph.dot module
    • Dot
      • Dot.generate()
  • citelang.main.graph.gexf module
    • Gexf
      • Gexf.generate()
  • citelang.main.graph.text module
    • Console
      • Console.generate()
  • citelang.main.graph.tree module
    • generate_tree()
    • print_tree()
  • citelang.main.packages module
  • citelang.main.packages.spack module
    • SpackManager
      • SpackManager.apiroot
      • SpackManager.color
      • SpackManager.default_language
      • SpackManager.default_versions
      • SpackManager.dependencies()
      • SpackManager.homepage
      • SpackManager.name
      • SpackManager.package()
      • SpackManager.project_count
  • citelang.main.packages.github module
    • GitHubManager
      • GitHubManager.apiroot
      • GitHubManager.clone()
      • GitHubManager.color
      • GitHubManager.default_language
      • GitHubManager.default_versions
      • GitHubManager.homepage
      • GitHubManager.name
      • GitHubManager.package()
      • GitHubManager.project_count
    • find_dependencies()
  • citelang.utils module
  • citelang.utils.fileio module
    • get_tmpdir()
    • get_tmpfile()
    • mkdir_p()
    • print_json()
    • read_file()
    • read_json()
    • read_yaml()
    • workdir()
    • write_file()
    • write_json()
  • citelang.utils.terminal module
    • clone()
    • confirm_action()
    • confirm_uninstall()
    • get_installdir()
    • get_time_now()
    • run_command()
  • citelang.version module