Metadata-Version: 2.1
Name: odoo-addon-github_connector_odoo
Version: 18.0.1.0.2
Requires-Python: >=3.10
Requires-Dist: odoo-addon-github_connector==18.0.*
Requires-Dist: odoo==18.0.*
Requires-Dist: pathspec
Summary: Analyze Odoo modules information from Github repositories
Home-page: https://github.com/OCA/interface-github
License: AGPL-3
Author: Odoo Community Association (OCA), Sylvain LE GAL, GRAP
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=======================
Github Connector - Odoo
=======================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:5f2f0c62e312304988d65dc78bd2f66c1f6d0e9b610f6f54cc74cc96b0319593
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Finterface--github-lightgray.png?logo=github
    :target: https://github.com/OCA/interface-github/tree/18.0/github_connector_odoo
    :alt: OCA/interface-github
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/interface-github-18-0/interface-github-18-0-github_connector_odoo
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/interface-github&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module was written to extend the functionality of 'Github
Connector' Module if your repositories contain Odoo Modules.

It extends 'Analysis' features to parse code files (readme / manifest
files) and add new models and menus.

|menu|

.. |menu| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/menu.png

**Table of contents**

.. contents::
   :local:

Configuration
=============

- Once installed, go to your organization, and set extra settings:

1. The name of your organization in the author keys of the manifest odoo
   modules (in the **Default Author Text** field)
2. The URL of the file that contains IDs of your repositories for the
   runbot

|github_organization_form|

If you had analyzed previously your repositories with the 'github
Connector' module, you should launch again the Analysis Process for all
your Repository Branches.

.. |github_organization_form| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/github_organization_form.png

Usage
=====

**Odoo Modules**

|odoo_module_kanban|

In each module, you can see the description of the module, the authors,
the available series, and the list of the modules that depend on the
current module.

|odoo_module_form|

**Odoo Authors**

|odoo_author|

This list is based on the 'author' key of the manifest file.

**Odoo License**

This list is based on the 'license' key of the manifest file.

|odoo_license|

**Odoo Bin Libs**

This list is based on the 'external_dependencies' / 'bin' key of the
manifest file.

|odoo_bin_libs|

**Odoo Python Libs**

This list is based on the 'external_dependencies' / 'python' key of the
manifest file.

|odoo_python_libs|

**Analysis source code**

Implements Analysis source code in odoo module versions, now add new
field called "has_odoo_addons" (boolean) in Analysis rule that allow (if
defined) analyze odoo_module_versions and save info about it

**Soource code analysis**

Implements Source code analysis odoo module versions, now addiing new
field called "has_odoo_addons" (boolean) in Analysis rule that (if
defined) allows to analyze odoo_module_versions and save info about it

In 'Repository Branch' / 'Code Analysis', shows the info related to
odoo_module_versions rules analysis too.

**Reporting**

This module provide a new reporting.

**Modules by Serie (and Licenses)**

|reporting_module_by_serie|

.. |odoo_module_kanban| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/odoo_module_kanban.png
.. |odoo_module_form| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/odoo_module_form.png
.. |odoo_author| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/odoo_author.png
.. |odoo_license| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/odoo_license.png
.. |odoo_bin_libs| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/odoo_bin_libs.png
.. |odoo_python_libs| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/odoo_python_libs.png
.. |reporting_module_by_serie| image:: https://raw.githubusercontent.com/OCA/interface-github/18.0/github_connector_odoo/static/description/reporting_module_by_serie.png

Known issues / Roadmap
======================

Possible improvements :

- Implement deep code source analysis, like the website
  http://odoo-code-search.com/ and specially:

1. Possibility to search by field or by model name. (Ex:
   field:invoice_id)
2. Possibility to display the number of XML, Python, Yaml, HTML, CSS
   lines

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/interface-github/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/interface-github/issues/new?body=module:%20github_connector_odoo%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Sylvain LE GAL
* GRAP

Contributors
------------

- Sylvain LE GAL (https://twitter.com/legalsylvain)
- `Tecnativa <https://www.tecnativa.com>`__:

  - Vicent Cubells
  - Alexandre Díaz
  - Pedro M. Baeza
  - Ernesto Tejeda
  - Víctor Martínez
  - Carolina Fernandez

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/interface-github <https://github.com/OCA/interface-github/tree/18.0/github_connector_odoo>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
