Github Connector

• github_create_date Datetime
  readonly=True string='Create Date on Github'
• github_id_external Char
  index=True readonly=True string='Github Id'
• github_last_sync_date Datetime
  readonly=True string='Last Sync Date with Github'
• github_name Char
  index=True readonly=True string='Github Technical Name'
• github_url Char
  readonly=True string='Github URL'
• github_write_date Datetime
  readonly=True string='Last Write Date on Github'

• button_update_from_github_full(self)
• button_update_from_github_light(self)
• create_from_name(self, name)
  @api.model
  Call Github API, using a URL using github name. Load data and Create Odoo object accordingly, if the odoo object doesn't exist. :param name: the github name to load :return: The created object :Example: >>> self.env['github_organization'].create_from_name('OCA') >>> self.env['github_repository'].create_from_name('OCA/web')
• create_in_github(self)
  Create an object in Github through the API As this depends on each object, it should be overwritten in each implementation class
• find_related_github_object(self, obj_id=None)
  @api.model
  Query Github API to find the related object This function should be overwritten in the child classes.
• full_update(self)
  Override this function in models that inherit this abstract to mention which items should be synchronized from github when the user clicks the 'Full Update' Button
• get_action(self)
• get_base64_image_from_github(self, url)
• get_conversion_dict(self)
  @api.model
  Prepare function that builds a map from Github fields to Odoo fields :return: Dictionary {odoo_field: github_field}
• get_from_id_or_create(self, gh_data=None, data=None, extra_data=None)
  @api.model
  Search if an Odoo object related to the Github data exists in database. If it does, it returns the object. Otherwise, it creates the new object. :param gh_data: Github object the will be used to get/create Odoo record :param data: dict with github 'id' and 'url' keys (deprecated) :param extra_data: dict with extra data to be put into the Odoo record :return: The searched or created object :Example: >>> self.env['github_organization'].get_from_id_or_create( data={'id': 7600578, 'url': 'https://api.github.com/orgs/OCA'})
• get_github_base_obj_for_creation(self)
  Should return the base object required to create the given item in Github. Usefull only if your model implements creation in github
• get_github_connector(self)
• get_odoo_data_from_github(self, data)
  @api.model
  Prepare function that maps data from a Github object to a dictionary of values ready to create an Odoo record
• github_login_field(self)
• process_timezone_fields(self, res)
• update_from_github(self, child_update)
  Call Github API, using a URL using github id. Load data and update Odoo object accordingly, if the odoo object is obsolete. (Based on last write dates) :param child_update: set to True if you want to reload childs Objects linked to this object. (like members for teams)

• group_id Many2one → github.analysis.rule.group
  comodel_name='github.analysis.rule.group' required=True string='Group'
• name Char
  required=True
• paths Text
  default='*' help='Define with pathspec especification' required=True

No public methods.

• name Char
  required=True

No public methods.

• analysis_rule_id Many2one → github.analysis.rule
  comodel_name='github.analysis.rule' ondelete='cascade' string='Analysis Rule'
• code_count Integer
  string='# Code'
• documentation_count Integer
  string='# Doc.'
• empty_count Integer
  string='# Empty'
• group_id Many2one
  readonly=True related='analysis_rule_id.group_id' string='Group'
• scanned_files Integer
• total_count Integer
  compute='_compute_total_count' store=True string='# Total'

No public methods.

• analysis_rule_ids Many2many → github.analysis.rule
  comodel_name='github.analysis.rule' string='Analysis Rules'
• ci_url_pattern Char
  string='CI URL Pattern'
• coverage_url_pattern Char
  string='Coverage URL Pattern'
• description Char
  readonly=True
• email Char
  readonly=True
• ignored_repository_names Text
  help='Set here repository names you want to ignore. One repository per line. If set, the repositories will be created, but branches synchronization and source code download will be disabled. Exemple:\npurchase-workflow\nOCB\nOpenUpgrade\n' string='Ignored Repositories'
• image Image
  readonly=True
• location Char
  readonly=True
• member_ids Many2many → res.partner
  column1='organization_id' column2='partner_id' comodel_name='res.partner' readonly=True relation='github_organization_partner_rel' string='Members'
• member_qty Integer
  compute='_compute_member_qty' store=True string='Number of Members'
• name Char
  readonly=True required=True string='Organization Name'
• organization_serie_ids One2many → github.organization.serie
  comodel_name='github.organization.serie' inverse_name='organization_id' string='Organization Series'
• organization_serie_qty Integer
  compute='_compute_organization_serie_qty' store=True string='Number of Series'
• repository_ids One2many → github.repository
  comodel_name='github.repository' inverse_name='organization_id' readonly=True string='Repositories'
• repository_qty Integer
  compute='_compute_repository_qty' store=True string='Number of Repositories'
• team_ids One2many → github.team
  comodel_name='github.team' inverse_name='organization_id' readonly=True string='Teams'
• team_qty Integer
  compute='_compute_team_qty' store=True string='Number of Teams'
• website_url Char
  readonly=True

• action_github_repository(self)
• action_github_team(self)
• action_res_partner(self)
• button_sync_member(self)
• button_sync_repository(self)
• button_sync_team(self)
• cron_update_organization_team(self)
  @api.model
• find_related_github_object(self, obj_id=None)
  Query Github API to find the related object
• full_update(self)
• get_conversion_dict(self)
  @api.model
• get_odoo_data_from_github(self, gh_data)
  @api.model

• name Char
  required=True
• organization_id Many2one → github.organization
  comodel_name='github.organization' ondelete='cascade' required=True string='Organization'
• sequence Integer
  required=True

No public methods.

• analysis_rule_ids Many2many → github.analysis.rule
  comodel_name='github.analysis.rule' string='Analysis Rules'
• color Integer
  compute='_compute_ignore' string='Color Index'
• complete_name Char
  compute='_compute_complete_name' readonly=True store=True
• description Char
  readonly=True
• inhibit_inherited_rules Boolean
  default=False help='If checked, the analysis rules to be used will be only those set here.\n If unchecked, the analysis rules to be used will be those set in the organization and those set here.' string='Inhibit inherited rules'
• is_ignored Boolean
  compute='_compute_ignore' help="If checked, the branches will not be synchronized, and the code source will this way not be downloaded and analyzed. To ignore a repository, go to the organization and add the file 'Ignored Repositories'."
• name Char
  index=True readonly=True required=True
• organization_id Many2one → github.organization
  comodel_name='github.organization' index=True ondelete='cascade' readonly=True required=True string='Organization'
• repository_branch_ids One2many → github.repository.branch
  comodel_name='github.repository.branch' inverse_name='repository_id' readonly=True string='Branches'
• repository_branch_qty Integer
  compute='_compute_repository_branch_qty' store=True string='Number of Branches'
• team_ids One2many → github.team.repository
  comodel_name='github.team.repository' inverse_name='repository_id' readonly=True string='Teams'
• team_qty Integer
  compute='_compute_team_qty' store=True string='Number of Teams'
• website Char
  readonly=True

• action_github_repository_branch(self)
• action_github_team_repository_from_repository(self)
• button_sync_branch(self)
• create_in_github(self)
  Create an object in Github through the API
• cron_update_branch_list(self)
  @api.model
• find_related_github_object(self, obj_id=None)
  Query Github API to find the related object
• full_update(self)
• get_conversion_dict(self)
  @api.model
• get_github_base_obj_for_creation(self)
• get_odoo_data_from_github(self, gh_data)
  @api.model

• analysis_rule_ids Many2many → github.analysis.rule
  comodel_name='github.analysis.rule' string='Analysis Rules'
• analysis_rule_info_ids One2many → github.repository.branch.rule.info
  comodel_name='github.repository.branch.rule.info' inverse_name='repository_branch_id' string='Analysis Rules (info)'
• ci_url Char
  compute='_compute_ci_url' store=True string='CI URL'
• complete_name Char
  compute='_compute_complete_name' store=True
• coverage_url Char
  compute='_compute_coverage_url' store=True string='Coverage URL'
• github_url Char
  compute='_compute_github_url' store=True string='Github URL'
• inhibit_inherited_rules Boolean
  default=False help='If checked, the analysis rules to be used will be only those set here.\n If unchecked, the analysis rules to be used will be those set in the organization, repository and those set here.' string='Inhibit inherited rules'
• last_analyze_date Datetime
• last_download_date Datetime
• local_path Char
  compute='_compute_local_path'
• mb_size Float
  compute='_compute_mb_size' store=True string='Size (Megabyte)'
• name Char
  index=True readonly=True
• organization_id Many2one → github.organization
  comodel_name='github.organization' readonly=True related='repository_id.organization_id' store=True string='Organization'
• organization_serie_id Many2one → github.organization.serie
  comodel_name='github.organization.serie' compute='_compute_organization_serie_id' store=True string='Organization Serie'
• repository_id Many2one → github.repository
  comodel_name='github.repository' index=True ondelete='cascade' readonly=True required=True string='Repository'
• sequence_serie Integer
  related='organization_serie_id.sequence' store=True string='Sequence Serie'
• size Integer
  readonly=True string='Size (Byte) '
• state Selection
  default='to_download' selection=_SELECTION_STATE

• analyze_code_one(self)
  Overload Me in custom Module that manage Source Code analysis.
• button_analyze_code(self)
• button_download_code(self)
• create_or_update_from_name(self, repository_id, name)
• cron_analyze_all(self)
  @api.model
• cron_download_all(self)
  @api.model
• set_analysis_rule_info(self)
  Do the cloc command only once and perform the analysis process.

• repository_branch_id Many2one → github.repository.branch
  comodel_name='github.repository.branch' ondelete='cascade' string='Repository Branch'

No public methods.

• analysis_rule_id Many2one → github.analysis.rule
  comodel_name='github.analysis.rule' string='Analysis Rule'
• code_count Integer
  string='# Code'
• documentation_count Integer
  string='# Documentation'
• empty_count Integer
  string='# Empty'
• group_id Many2one
  readonly=True related='analysis_rule_id.group_id' string='Group'
• organization_serie_id Many2one → github.organization.serie
  comodel_name='github.organization.serie' string='Organization serie'
• repository_branch_id Many2one → github.repository.branch
  comodel_name='github.repository.branch' string='Repository Branch'
• repository_id Many2one → github.repository
  comodel_name='github.repository' string='Repository'
• scanned_files Integer
• total_count Integer
  string='# Total'

• init(self)

• complete_name Char
  compute='_compute_complete_name' readonly=True store=True
• description Char
  readonly=True
• github_url Char
  compute='_compute_github_url' readonly=True string='Github URL'
• name Char
  index=True readonly=True required=True
• organization_id Many2one → github.organization
  comodel_name='github.organization' index=True ondelete='cascade' readonly=True required=True string='Organization'
• parent_id Many2one → github.team
  comodel_name='github.team' readonly=True string='Parent Team'
• partner_ids One2many → github.team.partner
  comodel_name='github.team.partner' inverse_name='team_id' readonly=True string='Members'
• partner_qty Integer
  compute='_compute_partner_qty' store=True string='Number of Members'
• privacy Selection
  default='secret' help='The level of privacy this team should have. Can be one of:\n* secret - only visible to organization owners and members of this team.\n* closed - visible to all members of this organization.' readonly=True selection=_PRIVACY_SELECTION
• repository_ids One2many → github.team.repository
  comodel_name='github.team.repository' inverse_name='team_id' readonly=True string='Repositories'
• repository_qty Integer
  compute='_compute_repository_qty' store=True string='Number of Repositories'

• action_github_team_partner_from_team(self)
• action_github_team_repository_from_team(self)
• button_sync_member(self)
• button_sync_repository(self)
• create_in_github(self)
  Create an object in Github through the API
• find_related_github_object(self, obj_id=None)
  Query Github API to find the related object
• full_update(self)
• get_conversion_dict(self)
  @api.model
• get_github_base_obj_for_creation(self)
• get_odoo_data_from_github(self, gh_data)
  @api.model

• context_search_default_partner_id Integer
  compute='_compute_context_search_default'
• context_search_default_team_id Integer
  compute='_compute_context_search_default'
• partner_id Many2one → res.partner
  comodel_name='res.partner' index=True ondelete='cascade' readonly=True required=True string='Member'
• role Selection
  readonly=True required=True selection=_ROLE_SELECTION
• team_id Many2one → github.team
  comodel_name='github.team' index=True ondelete='cascade' readonly=True required=True string='Team'

No public methods.

• context_search_default_repository_id Integer
  compute='_compute_context_search_default'
• context_search_default_team_id Integer
  compute='_compute_context_search_default'
• permission Selection
  readonly=True required=True selection=_PERMISSION_SELECTION
• repository_id Many2one → github.repository
  comodel_name='github.repository' index=True ondelete='cascade' readonly=True required=True string='Repository'
• team_id Many2one → github.team
  comodel_name='github.team' index=True ondelete='cascade' readonly=True required=True string='Team'

No public methods.

• github_team_partner_ids One2many → github.team.partner
  comodel_name='github.team.partner' inverse_name='partner_id' readonly=True string='Teams'
• github_team_qty Integer
  compute='_compute_github_team_qty' store=True string='Number of Teams'
• is_bot_account Boolean
  help='Check this box if this account is a bot or similar.' string='Is Bot Github Account'
• organization_ids Many2many → github.organization
  column1='partner_id' column2='organization_id' comodel_name='github.organization' readonly=True relation='github_organization_partner_rel' string='Organizations'
• organization_qty Integer
  compute='_compute_organization_qty' store=True string='Number of Organizations'

• action_github_organization(self)
• action_github_team_partner_from_partner(self)
• find_related_github_object(self, obj_id=None)
  Query Github API to find the related object
• get_conversion_dict(self)
  @api.model
• get_odoo_data_from_github(self, gh_data)
  @api.model

• description Char
  readonly=False
• name Char
  readonly=False
• organization_id Many2one
  readonly=False
• website Char
  readonly=False

• button_create_in_github(self)
• get_github_data_from_odoo(self)

• description Char
  readonly=False
• name Char
  readonly=False
• organization_id Many2one
  readonly=False
• privacy Selection
  readonly=False
• wizard_partner_ids Many2many → res.partner
  comodel_name='res.partner' domain="[('github_name', '!=', False)]" string='Team Members'
• wizard_repository_ids Many2many → github.repository
  comodel_name='github.repository' string='Team Repositories'

• button_create_in_github(self)
• get_github_data_from_odoo(self)

• child_update Boolean
  default=False string='Update Child Objects'
• github_type Selection
  default='organization' required=True selection=[('organization', 'Organization'), ('repository', 'Repository'), ('user', 'User')] string='Github Type Name'
• name Char
  required=True string='Github Name'

• button_create_from_github(self)