Author: |
Odoo Community Association (OCA), Sylvain LE GAL, GRAP |
License: |
AGPL-3 |
Branch: |
10.0 |
Repository: |
Change2improve/interface-github |
Dependencies: |
base,
and
github_connector |
Languages: |
Python (699, 50.1%),
XML (628, 45.0%),
and
reStructuredText (69, 4.9%) |
Other branches: |
11.0,
12.0,
13.0,
14.0,
and
15.0 |
Other repositories: |
Dobtor-OCA/interface-github,
ERPLibre/interface-github,
ForgeFlow/interface-github,
Freni-SerpentCS/interface-github,
Gabinete-Digital/interface-github,
Guobower/interface-github,
InformaticaArelux/interface-github,
JazziMc/interface-github,
MrZ-777/interface-github,
Numigi/interface-github,
OCA/interface-github,
RoelAdriaans/interface-github,
SeuMarco/interface-github,
StephanRozendaal/interface-github,
Tecnativa/interface-github,
Vauxoo/interface-github,
VisiionSolucionesTecnologicas/interface-github,
acsone/interface-github,
akretion/interface-github,
apetbiz/interface-github,
aurestic/interface-github,
bizzappdev/interface-github,
bjoliveau/oca-custom,
czgonroad/interface-github,
diagramsoftware/interface-github,
efatto/interface-github,
grap/interface-github,
haroldtamo/interface-github,
hbrunn/interface-github,
iRichGit/interface-github,
jsilvestar/interface-github,
legalsylvain/interface-github,
legalsylvain/oca-custom-1,
leminhooyahoo/interface-github,
lideritjnma/interface-github,
maartenleijnse/interface-github,
murtuzasaleh/interface-github,
oscarolar/interface-github,
oscars8a/interface-github,
pnajman-modoolar/interface-github,
pscloud/interface-github,
royalline1/interface-github,
sanube/interface-github,
shiftctrl-io/interface-github,
simplifysolutions/interface-github,
sunshineLhj/interface-github,
and
xwh123807/interface-github |
<img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a name="analyze-odoo-modules-information-from-github-repositories"></a>
<h2>Analyze Odoo modules information from Github repositories</h2>
<p>This module was written to extend the functionality of 'Github Connector' Module
if your repositories contain Odoo Modules.</p>
<p>It extends 'Analysis' features to parse code files (readme / manifest files)
and add new models and menus.</p>
<img alt="/github_connector_odoo/static/description/menu.png" src="/github_connector_odoo/static/description/menu.png" />
<a name="configuration"></a>
<h3>Configuration</h3>
<ul class="simple">
<li>Once installed, go to your organization, and set extra settings:</li>
</ul>
<ol class="arabic simple">
<li>The name of your organization in the author keys of the manifest odoo modules</li>
<li>The URL of the file that contains IDs of your repositories for the runbot</li>
</ol>
<img alt="/github_connector_odoo/static/description/github_organization_form.png" src="/github_connector_odoo/static/description/github_organization_form.png" />
<p>If you had analyzed previously your repositories with the
'github Connector' module, you should launch again the Analysis Process
for all your Repository Branches.</p>
<a name="usage"></a>
<h3>Usage</h3>
<a name="odoo-modules"></a>
<h4>Odoo Modules</h4>
<img alt="/github_connector_odoo/static/description/odoo_module_kanban.png" src="/github_connector_odoo/static/description/odoo_module_kanban.png" />
<p>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.</p>
<img alt="/github_connector_odoo/static/description/odoo_module_form.png" src="/github_connector_odoo/static/description/odoo_module_form.png" />
<a name="odoo-authors"></a>
<h4>Odoo Authors</h4>
<img alt="/github_connector_odoo/static/description/odoo_author.png" src="/github_connector_odoo/static/description/odoo_author.png" />
<p>This list is based on the 'author' key of the manifest file.</p>
<a name="odoo-license"></a>
<h4>Odoo License</h4>
<p>This list is based on the 'license' key of the manifest file.</p>
<img alt="/github_connector_odoo/static/description/odoo_license.png" src="/github_connector_odoo/static/description/odoo_license.png" />
<a name="odoo-bin-libs"></a>
<h4>Odoo Bin Libs</h4>
<p>This list is based on the 'external_dependencies' / 'bin' key of the
manifest file.</p>
<img alt="/github_connector_odoo/static/description/odoo_bin_libs.png" src="/github_connector_odoo/static/description/odoo_bin_libs.png" />
<a name="odoo-python-libs"></a>
<h4>Odoo Python Libs</h4>
<p>This list is based on the 'external_dependencies' / 'python' key of the
manifest file.</p>
<img alt="/github_connector_odoo/static/description/odoo_python_libs.png" src="/github_connector_odoo/static/description/odoo_python_libs.png" />
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/229/10.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="reporting"></a>
<h3>Reporting</h3>
<p>This module provide a new reporting.</p>
<p><strong>Modules by Serie (and Licenses)</strong></p>
<img alt="/github_connector_odoo/static/description/reporting_module_by_serie.png" src="/github_connector_odoo/static/description/reporting_module_by_serie.png" />
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<p>Possible improvements :</p>
<ul class="simple">
<li>Implement deep code source analysis, like the website <a class="reference external" href="http://odoo-code-search.com/">http://odoo-code-search.com/</a>
and specially:</li>
</ul>
<ol class="arabic simple">
<li>Possibility to search by field or by model name. (Ex: field:invoice_id)</li>
<li>Possibility to display the number of XML, Python, Yaml, HTML, CSS lines</li>
</ol>
<ul class="simple">
<li>Implement Social feature, like possibility to comment a module, add a
notation, like the website <a class="reference external" href="https://www.odoo.com/apps">https://www.odoo.com/apps</a></li>
<li>Create a new module github_connector_odoo_website, that could display
the modules informations for non logged users.</li>
</ul>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/interface-github/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li>
</ul>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>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.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>