Skip to content

Commit

Permalink
[IMP] web_leaflet_lib: pre-commit stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
legalsylvain committed Oct 29, 2024
1 parent b52bb1b commit 548f7fb
Show file tree
Hide file tree
Showing 10 changed files with 86 additions and 68 deletions.
54 changes: 29 additions & 25 deletions web_leaflet_lib/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Leaflet Javascript Library
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fgeospatial-lightgray.png?logo=github
:target: https://github.com/OCA/geospatial/tree/16.0/web_leaflet_lib
:target: https://github.com/OCA/geospatial/tree/17.0/web_leaflet_lib
:alt: OCA/geospatial
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/geospatial-16-0/geospatial-16-0-web_leaflet_lib
:target: https://translation.odoo-community.org/projects/geospatial-17-0/geospatial-17-0-web_leaflet_lib
: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/geospatial&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/geospatial&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|
Expand All @@ -34,24 +34,29 @@ This module is used by ``web_view_leaflet_map``.

**Important Note**

The javascript library is opensource and distributed under BSD 2 Licence.
See : https://github.com/Leaflet/Leaflet/blob/main/LICENSE
You can so use it freely.
The javascript library is opensource and distributed under BSD 2
Licence. See : https://github.com/Leaflet/Leaflet/blob/main/LICENSE You
can so use it freely.

However, display maps requires to display layers provided by tiles servers, that
requires ressources.
However, display maps requires to display layers provided by tiles
servers, that requires ressources.

**For testing purpose**

You can use the openStreetMap url ``https://tile.openstreetmap.org/{z}/{x}/{y}.png`` or other, listed in that page : https://wiki.openstreetmap.org/wiki/Tile_servers
You can use the openStreetMap url
``https://tile.openstreetmap.org/{z}/{x}/{y}.png`` or other, listed in
that page : https://wiki.openstreetmap.org/wiki/Tile_servers

Apart from very limited testing purposes, you should not use the tiles supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run non-profit body and cannot supply tiles for large-scale commercial use.
Apart from very limited testing purposes, you should not use the tiles
supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run
non-profit body and cannot supply tiles for large-scale commercial use.

**Regular / High Usage**

- you can contact one of the following companies : https://switch2osm.org/providers/

- You can also install yourself your own tiles servers. See documentation : https://switch2osm.org/serving-tiles/
- you can contact one of the following companies :
https://switch2osm.org/providers/
- You can also install yourself your own tiles servers. See
documentation : https://switch2osm.org/serving-tiles/

**Table of contents**

Expand All @@ -61,42 +66,41 @@ Apart from very limited testing purposes, you should not use the tiles supplied
Configuration
=============

* Go to Settings > Technical > Parameters > System Parameters

* Create or edit the parameter with the key ``leaflet.tile_url``

* As a value, set the url of the tiles server you chose. (See description)
- Go to Settings > Technical > Parameters > System Parameters
- Create or edit the parameter with the key ``leaflet.tile_url``
- As a value, set the url of the tiles server you chose. (See
description)

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/geospatial/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/geospatial/issues/new?body=module:%20web_leaflet_lib%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/geospatial/issues/new?body=module:%20web_leaflet_lib%0Aversion:%2017.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
~~~~~~~
-------

* GRAP

Contributors
~~~~~~~~~~~~
------------

* Sylvain LE GAL (https://www.twitter.com/legalsylvain)
- Sylvain LE GAL (https://www.twitter.com/legalsylvain)

Other credits
~~~~~~~~~~~~~
-------------

The module embed the Leaflet.js library.

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -116,6 +120,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-legalsylvain|

This module is part of the `OCA/geospatial <https://github.com/OCA/geospatial/tree/16.0/web_leaflet_lib>`_ project on GitHub.
This module is part of the `OCA/geospatial <https://github.com/OCA/geospatial/tree/17.0/web_leaflet_lib>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions web_leaflet_lib/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
4 changes: 4 additions & 0 deletions web_leaflet_lib/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- Go to Settings \> Technical \> Parameters \> System Parameters
- Create or edit the parameter with the key `leaflet.tile_url`
- As a value, set the url of the tiles server you chose. (See
description)
5 changes: 0 additions & 5 deletions web_leaflet_lib/readme/CONFIGURE.rst

This file was deleted.

1 change: 1 addition & 0 deletions web_leaflet_lib/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Sylvain LE GAL (<https://www.twitter.com/legalsylvain>)
1 change: 0 additions & 1 deletion web_leaflet_lib/readme/CONTRIBUTORS.rst

This file was deleted.

File renamed without changes.
29 changes: 29 additions & 0 deletions web_leaflet_lib/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
This module extends odoo to include Leaflet Javacript library.

This module is used by `web_view_leaflet_map`.

**Important Note**

The javascript library is opensource and distributed under BSD 2
Licence. See : <https://github.com/Leaflet/Leaflet/blob/main/LICENSE>
You can so use it freely.

However, display maps requires to display layers provided by tiles
servers, that requires ressources.

**For testing purpose**

You can use the openStreetMap url
`https://tile.openstreetmap.org/{z}/{x}/{y}.png` or other, listed in
that page : <https://wiki.openstreetmap.org/wiki/Tile_servers>

Apart from very limited testing purposes, you should not use the tiles
supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run
non-profit body and cannot supply tiles for large-scale commercial use.

**Regular / High Usage**

- you can contact one of the following companies :
<https://switch2osm.org/providers/>
- You can also install yourself your own tiles servers. See
documentation : <https://switch2osm.org/serving-tiles/>
24 changes: 0 additions & 24 deletions web_leaflet_lib/readme/DESCRIPTION.rst

This file was deleted.

33 changes: 20 additions & 13 deletions web_leaflet_lib/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,22 +369,28 @@ <h1 class="title">Leaflet Javascript Library</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:e5af47c08dbb573c870e80a506feaccced35a36e61e63c6d39644fa84a357de1
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/geospatial/tree/16.0/web_leaflet_lib"><img alt="OCA/geospatial" src="https://img.shields.io/badge/github-OCA%2Fgeospatial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/geospatial-16-0/geospatial-16-0-web_leaflet_lib"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/geospatial&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/geospatial/tree/17.0/web_leaflet_lib"><img alt="OCA/geospatial" src="https://img.shields.io/badge/github-OCA%2Fgeospatial-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/geospatial-17-0/geospatial-17-0-web_leaflet_lib"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/geospatial&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>This module extends odoo to include Leaflet Javacript library.</p>
<p>This module is used by <tt class="docutils literal">web_view_leaflet_map</tt>.</p>
<p><strong>Important Note</strong></p>
<p>The javascript library is opensource and distributed under BSD 2 Licence.
See : <a class="reference external" href="https://github.com/Leaflet/Leaflet/blob/main/LICENSE">https://github.com/Leaflet/Leaflet/blob/main/LICENSE</a>
You can so use it freely.</p>
<p>However, display maps requires to display layers provided by tiles servers, that
requires ressources.</p>
<p>The javascript library is opensource and distributed under BSD 2
Licence. See : <a class="reference external" href="https://github.com/Leaflet/Leaflet/blob/main/LICENSE">https://github.com/Leaflet/Leaflet/blob/main/LICENSE</a> You
can so use it freely.</p>
<p>However, display maps requires to display layers provided by tiles
servers, that requires ressources.</p>
<p><strong>For testing purpose</strong></p>
<p>You can use the openStreetMap url <tt class="docutils literal"><span class="pre">https://tile.openstreetmap.org/{z}/{x}/{y}.png</span></tt> or other, listed in that page : <a class="reference external" href="https://wiki.openstreetmap.org/wiki/Tile_servers">https://wiki.openstreetmap.org/wiki/Tile_servers</a></p>
<p>Apart from very limited testing purposes, you should not use the tiles supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run non-profit body and cannot supply tiles for large-scale commercial use.</p>
<p>You can use the openStreetMap url
<tt class="docutils literal"><span class="pre">https://tile.openstreetmap.org/{z}/{x}/{y}.png</span></tt> or other, listed in
that page : <a class="reference external" href="https://wiki.openstreetmap.org/wiki/Tile_servers">https://wiki.openstreetmap.org/wiki/Tile_servers</a></p>
<p>Apart from very limited testing purposes, you should not use the tiles
supplied by OpenStreetMap.org itself. OpenStreetMap is a volunteer-run
non-profit body and cannot supply tiles for large-scale commercial use.</p>
<p><strong>Regular / High Usage</strong></p>
<ul class="simple">
<li>you can contact one of the following companies : <a class="reference external" href="https://switch2osm.org/providers/">https://switch2osm.org/providers/</a></li>
<li>You can also install yourself your own tiles servers. See documentation : <a class="reference external" href="https://switch2osm.org/serving-tiles/">https://switch2osm.org/serving-tiles/</a></li>
<li>you can contact one of the following companies :
<a class="reference external" href="https://switch2osm.org/providers/">https://switch2osm.org/providers/</a></li>
<li>You can also install yourself your own tiles servers. See
documentation : <a class="reference external" href="https://switch2osm.org/serving-tiles/">https://switch2osm.org/serving-tiles/</a></li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
Expand All @@ -405,15 +411,16 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<ul class="simple">
<li>Go to Settings &gt; Technical &gt; Parameters &gt; System Parameters</li>
<li>Create or edit the parameter with the key <tt class="docutils literal">leaflet.tile_url</tt></li>
<li>As a value, set the url of the tiles server you chose. (See description)</li>
<li>As a value, set the url of the tiles server you chose. (See
description)</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/geospatial/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 to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/geospatial/issues/new?body=module:%20web_leaflet_lib%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/geospatial/issues/new?body=module:%20web_leaflet_lib%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
Expand Down Expand Up @@ -445,7 +452,7 @@ <h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external image-reference" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/geospatial/tree/16.0/web_leaflet_lib">OCA/geospatial</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/geospatial/tree/17.0/web_leaflet_lib">OCA/geospatial</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down

0 comments on commit 548f7fb

Please sign in to comment.