diff --git a/.gitignore b/.gitignore index 8aa9a2d..d8c2405 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,6 @@ docs/*.svg # Page de presentation : hors depot (publiee sur le NAS par site/deploy.ps1 ; # sa configuration contient hote, compte et chemin de cle SSH) site/ + +# Archives a publier (python package.py) +dist/ diff --git a/Docs/icon.png b/Docs/icon.png new file mode 100644 index 0000000..66e51d0 Binary files /dev/null and b/Docs/icon.png differ diff --git a/Docs/make_icon.py b/Docs/make_icon.py new file mode 100644 index 0000000..c706a3d --- /dev/null +++ b/Docs/make_icon.py @@ -0,0 +1,57 @@ +#!/usr/bin/env python3 +# coding=utf-8 +# SPDX-License-Identifier: GPL-2.0-or-later +# Copyright (C) 2026 Alex +""" +Generates the icon of the extension for inkscape.org: a disc filled with the +maze computed by dog_bandana_core (same function as the extension). + + python docs/make_icon.py # docs/icon.svg + docs/icon.png (256 px) +""" + +import math +import os +import subprocess +import sys + +HERE = os.path.dirname(os.path.abspath(__file__)) +sys.path.insert(0, os.path.dirname(HERE)) + +from dog_bandana_core import polylines_to_d, turing_pattern # noqa: E402 + +SIZE = 256 +INKSCAPE = [r"C:\Program Files\Inkscape\bin\inkscape.com", "/usr/bin/inkscape", + "/Applications/Inkscape.app/Contents/MacOS/inkscape"] + + +def main(): + center, radius = SIZE / 2, SIZE / 2 - 8 + ring = [(center + radius * math.cos(2 * math.pi * k / 180), + center + radius * math.sin(2 * math.pi * k / 180)) for k in range(180)] + period, width = 22, 10 + lines = turing_pattern([ring], period, width, margin=6, seed=3, steps=80) + svg = ('\n' + '\n' + '\n' + '\n' + '\n').format(SIZE, center, radius, polylines_to_d(lines, 2), width) + svg_path = os.path.join(HERE, "icon.svg") + png_path = os.path.join(HERE, "icon.png") + with open(svg_path, "w", encoding="utf-8", newline="\n") as handle: + handle.write(svg) + print(svg_path) + exe = next((path for path in INKSCAPE if os.path.exists(path)), None) + if exe is None: + print("Inkscape not found: export {} by hand".format(svg_path)) + return + subprocess.run([exe, svg_path, "--export-type=png", "--export-width={}".format(SIZE), + "--export-filename={}".format(png_path)], + check=True, stderr=subprocess.DEVNULL) + print(png_path) + + +if __name__ == "__main__": + main() diff --git a/Docs/schema_parametres.py b/Docs/schema_parametres.py index cf9493a..7a34e85 100644 --- a/Docs/schema_parametres.py +++ b/Docs/schema_parametres.py @@ -1,18 +1,20 @@ #!/usr/bin/env python3 # coding=utf-8 +# SPDX-License-Identifier: GPL-2.0-or-later +# Copyright (C) 2026 Alex """ -Genere le schema explicatif des parametres de l'extension. +Generates the diagram that explains the extension parameters. - python docs/schema_parametres.py # les deux versions + python docs/schema_parametres.py # both versions python docs/schema_parametres.py fr # docs/parametres.svg + .png (README) python docs/schema_parametres.py en # docs/parameters_en.svg - # + images/parameters_en.png (onglet - # « Help » de la boite de dialogue) + # + images/parameters_en.png ("Help" + # tab of the dialog) -Les formes sont calculees par dog_bandana_core (memes fonctions que l'extension), -le schema reste donc fidele au resultat reel. L'export PNG passe par -inkscape.com, qui attend la fin de l'export (contrairement au raccourci -Chocolatey « inkscape »). +Shapes are computed by dog_bandana_core (same functions as the extension), +so the diagram stays faithful to the actual result. PNG export goes through +inkscape.com, which waits for the export to finish (unlike the Chocolatey +"inkscape" shim). """ import math @@ -26,21 +28,21 @@ sys.path.insert(0, ROOT) import dog_bandana_core # noqa: E402 -W, H = 1400, 1280 # 4 panneaux de 700 x 640 +W, H = 1400, 1280 # 4 panels of 700 x 640 -INK = "#343a40" # element principal -GHOST = "#dde1e5" # elements secondaires / voisins -DIM = "#d9480f" # cotes -DIM2 = "#1971c2" # cotes secondaires -EDGE = "#212529" # contour des formes +INK = "#343a40" # main element +GHOST = "#dde1e5" # secondary / neighbouring elements +DIM = "#d9480f" # dimensions +DIM2 = "#1971c2" # secondary dimensions +EDGE = "#212529" # shape outlines FONT = "font-family:Arial,Helvetica,sans-serif" INKSCAPE = [r"C:\Program Files\Inkscape\bin\inkscape.com", "/usr/bin/inkscape", "/Applications/Inkscape.app/Contents/MacOS/inkscape"] -# Version par langue : textes, fichiers produits, largeur du PNG et agrandissement -# des textes (la version anglaise est affichee reduite dans la boite de dialogue : -# 900 px de large, textes x 1.25 pour rester lisibles). +# Version per language: texts, output files, PNG width and text scaling (the +# English version is shown reduced in the dialog: 900 px wide, texts x 1.25 to +# stay readable). VERSIONS = { "fr": { "svg": os.path.join(HERE, "parametres.svg"), @@ -103,7 +105,7 @@ VERSIONS = { } def _unit(angle): - """Vecteur unitaire, angle en degres, sens anti-horaire a l'ecran (y vers le bas).""" + """Unit vector, angle in degrees, counterclockwise on screen (y pointing down).""" a = math.radians(angle) return math.cos(a), -math.sin(a) @@ -141,7 +143,7 @@ def text(x, y, s, size=17, color=INK, anchor="start", weight="normal", halo=True def note(x, y, lines): - """Legende de bas de panneau, derniere ligne sur la ligne de base `y`.""" + """Panel caption, last line on baseline `y`.""" step = 22 * FS for k, line in enumerate(lines): text(x, y - (len(lines) - 1 - k) * step, line, size=16, halo=False) @@ -157,7 +159,7 @@ def arrow_head(tip, direction, color, size=9): def dimension(p, q, offset, label, color=DIM, label_pos=0.5, label_shift=18, size=17): - """Cote entre p et q, decalee de `offset` perpendiculairement.""" + """Dimension between p and q, shifted by `offset` perpendicularly.""" dx, dy = q[0] - p[0], q[1] - p[1] length = math.hypot(dx, dy) ux, uy = dx / length, dy / length @@ -178,7 +180,7 @@ def dimension(p, q, offset, label, color=DIM, label_pos=0.5, label_shift=18, siz def arc(center, radius, a0, a1, color, label=None, label_radius=None, size=16): - """Arc de a0 a a1 degres (sens anti-horaire a l'ecran), fleche au bout.""" + """Arc from a0 to a1 degrees (counterclockwise on screen), arrow at the end.""" steps = 40 points = [] for k in range(steps + 1): @@ -206,12 +208,12 @@ def panel_title(x, y, number, title): # -------------------------------------------------------------------------- -# Panneaux : un par parametre (ou groupe de parametres), numerotes 1 a 4. -# Motifs calcules par dog_bandana_core.turing_pattern, comme dans l'extension. +# Panels: one per parameter (or group of parameters), numbered 1 to 4. +# Patterns computed by dog_bandana_core.turing_pattern, as in the extension. # -------------------------------------------------------------------------- def strokes(polylines, color, width): - """Traits a bouts ronds, comme ceux produits par l'extension.""" + """Round-capped strokes, like those produced by the extension.""" for pl in polylines: out.append(''.format( @@ -230,7 +232,7 @@ def rect_ring(x0, y0, x1, y1): def crossings(polylines, x): - """Intersections des polylignes avec la verticale x : (y, pente, numero).""" + """Crossings of the polylines with the vertical x: (y, slope, index).""" found = [] for index, pl in enumerate(polylines): for (ax, ay), (bx, by) in zip(pl, pl[1:]): @@ -241,16 +243,16 @@ def crossings(polylines, x): def panel_1(): - """Periode et epaisseur : cotes sur deux lignes voisines bien paralleles.""" + """Period and width: dimensions on two neighbouring, nearly parallel lines.""" period, width = 64, 28 region = rect_ring(60, 90, 640, 530) def near(cuts, index, y): return any(i == index and abs(cy - y) < 6 for cy, _s, i in cuts) - # Cherche deux lignes voisines presque horizontales sur une bonne longueur - # (verticales x - 70, x, x + 70), espacees d'environ une periode : les - # cotes tiennent dans l'espace blanc entre elles. + # Look for two neighbouring lines, nearly horizontal over a good length + # (verticals x - 70, x, x + 70), about one period apart: the dimensions + # fit in the white space between them. best = None for seed in range(1, 9): lines = dog_bandana_core.turing_pattern([region], period, width, seed=seed, @@ -272,12 +274,12 @@ def panel_1(): strokes([pl for k, pl in enumerate(lines) if k not in (i1, i2)], GHOST, width) strokes([lines[i1], lines[i2]], INK, width) outline([region], EDGE, 2) - # Periode : d'axe en axe ; epaisseur : bord a bord d'une meme ligne. + # Period: center to center; width: edge to edge of a single line. for y in (y1, y2): polyline([(x - 25, y), (x + 25, y)], DIM, 1.4, 'stroke-dasharray="4,3"') dimension((x, y1), (x, y2), 0, "") text(x + 12, (y1 + y2) / 2 + 6, T["period"], color=DIM, weight="bold") - # Epaisseur sur la ligne du bas, legende dessous (zone claire). + # Width on the lower line, label below it (clear area). xw = x - 70 dimension((xw, y2 - width / 2), (xw, y2 + width / 2), 0, "", color=DIM2) text(xw, y2 + width / 2 + 28, T["width"], color=DIM2, anchor="middle", @@ -286,7 +288,7 @@ def panel_1(): def panel_2(): - """Iterations : meme graine, trois durees d'evolution.""" + """Iterations: same seed, three evolution times.""" ox = 700 panel_title(ox + 30, 50, 2, T["title2"]) size, gap = 190, 25 @@ -308,7 +310,7 @@ def panel_2(): def panel_3(): - """Bord de la forme : motif coupe (tissu decoupe) ou qui longe le bord.""" + """Shape edge: pattern cut (like fabric) or running along the edge.""" oy = 640 panel_title(30, oy + 50, 3, T["title3"]) for k, edge in enumerate(("cut", "follow")): @@ -323,7 +325,7 @@ def panel_3(): def panel_4(): - """Marge : espace libre entre le bord et les traits.""" + """Margin: free space between the edge and the strokes.""" ox, oy = 700, 640 panel_title(ox + 30, oy + 50, 4, T["title4"]) margin, period, width = 40, 30, 14 @@ -342,7 +344,7 @@ def panel_4(): def export_png(svg_path, png_path, width): exe = next((path for path in INKSCAPE if os.path.exists(path)), None) if exe is None: - print("Inkscape introuvable : exporter {} a la main".format(svg_path)) + print("Inkscape not found: export {} by hand".format(svg_path)) return os.makedirs(os.path.dirname(png_path), exist_ok=True) subprocess.run([exe, svg_path, "--export-type=png", diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b83f24b --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/PUBLICATION.md b/PUBLICATION.md new file mode 100644 index 0000000..605a3bb --- /dev/null +++ b/PUBLICATION.md @@ -0,0 +1,134 @@ +# Publication sur inkscape.org + +Marche à suivre d'après +[Submitting and Publishing an Inkscape Extension](https://inkscape.gitlab.io/extensions/documentation/authors/submit.html), +et état de chaque point pour la version **1.0.0**. + +## 1. Conditions de la page + +| Exigence | État | +| -------- | ---- | +| Pas d'accès à Internet, pas d'auto-mise à jour, aucune écriture dans le dossier de configuration | ✅ aucun accès réseau ni fichier écrit (seule la variable `LANGUAGE` du processus est renseignée) | +| Code lisible, en anglais | ✅ commentaires et docstrings des `.py` et du `.inx` en anglais | +| Licence libre, pour le code et les dépendances | ✅ GPL-2.0-or-later (`LICENSE`, en-tête SPDX dans chaque `.py`) ; `numpy` et `lxml` (BSD) sont fournis avec Inkscape | +| Python 3.8 ou plus récent | ✅ grammaire 3.8 vérifiée par `package.py` ; exécuté avec le Python 3.12 d'Inkscape 1.4.4 | +| Dépendances absentes d'Inkscape embarquées | ✅ aucune : `inkex`, `numpy`, `lxml` sont livrés avec Inkscape | +| Un seul zip, toutes plates-formes, fichiers à la racine | ✅ `python package.py` | +| Fonctionne avec au moins une version d'Inkscape | ✅ Inkscape 1.4.4 (Windows) ; autres versions à essayer, voir § 3 | + +Contrôles des relecteurs, déjà passés : `.inx` + `.py` présents, licence, +`pytest` (37 tests réussis), `pylint` **9,65/10** (restent des avertissements +« trop d'arguments / de variables locales » sur les fonctions de calcul et +deux suggestions de f-string). + +## 2. Construire le paquet + +```powershell +python i18n.py # traductions à jour (0 à traduire) +python -m pytest -q # avec PYTHONPATH vers les extensions d'Inkscape : 37 réussis +python docs/make_icon.py # docs/icon.png (256 px), si besoin +python package.py # dist/dog_bandana-1.0.0.zip + .md5 +``` + +Contenu du zip : `dog_bandana.inx`, `dog_bandana.py`, `dog_bandana_core.py`, +`images/parameters_en.png`, `locale/{en,fr}/LC_MESSAGES/dogbandana.mo`, +`LICENSE`, `README.en.md`. + +La version vient de `__version__` dans `dog_bandana_core.py` : l'augmenter à +chaque nouvelle publication. + +## 3. Essayer le zip dans Inkscape (à faire pour chaque version annoncée) + +Profil vierge, pour ne pas mélanger avec l'extension déjà déployée : + +```powershell +$env:INKSCAPE_PROFILE_DIR = "$env:TEMP\inkscape-test-profile" +& 'C:\Program Files\Inkscape\bin\inkscape.exe' +``` + +Puis **Extensions › Gérer les extensions…**, deuxième onglet, bouton dossier +en bas, choisir `dist\dog_bandana-1.0.0.zip`. Redémarrer Inkscape (même +variable), dessiner une forme, lancer l'extension. Fermer, puis +`Remove-Item Env:INKSCAPE_PROFILE_DIR`. + +Déjà vérifié : le zip installé dans un profil vierge d'Inkscape 1.4.4 est +chargé, ses paramètres sont transmis et ses messages sont en français ; le +calcul tourne avec le Python et le numpy d'Inkscape. Reste à faire à la main : +l'installation par le gestionnaire d'extensions et un essai sur la sélection +dans l'interface (Inkscape en ligne de commande ne transmet pas la sélection +aux effets). Si d'autres versions (1.2, 1.3…) sont disponibles, les essayer +et les noter pour les étiquettes de compatibilité. + +## 4. Signer le zip + +Méthode recommandée : signature GnuPG détachée, avec la clé publique déposée +dans le profil inkscape.org (aucune clé secrète n'existe encore sur ce poste) : + +```powershell +gpg --full-generate-key # une seule fois +gpg --armor --export # à coller dans le profil inkscape.org +python package.py --sign # dist/dog_bandana-1.0.0.sig +``` + +À défaut (moins sûr) : l'empreinte md5 de `dist/dog_bandana-1.0.0.zip.md5` +(il faut alors un texte quelconque dans le champ signature de la clé GnuPG du +profil inkscape.org pour que le champ md5 apparaisse). + +## 5. Déposer sur inkscape.org + +Rubrique **Extensions** de la galerie, avec : + +- le zip et sa signature (`.sig`, ou le md5) ; +- l'icône `docs/icon.png` et une capture : `docs/apercu.png`, idéalement + remplacée par une vraie capture d'Inkscape (boîte de dialogue + résultat) ; +- les versions d'Inkscape essayées (au moins **1.4**) ; +- le lien du dépôt : https://git.alex-design.fr/Alex/inkscape.motif.DogBandana + (le dépôt doit être public et contenir le code avant la demande de relecture) ; +- le titre et la description ci-dessous (en anglais, exigé). + +**Titre** + +```text +Dog Bandana Pattern Fill +``` + +**Description** + +```text +Fills the selected shapes with a Turing maze: winding lines of constant width +that branch, sometimes close into loops, and end in round tips (the "noodle" +pattern often seen on dog bandanas). + +The pattern is computed with the Swift-Hohenberg equation (labyrinth regime) +on a grid covering each shape, then reduced to the center line of every band: +one round-capped stroke per noodle, ready for line engraving on a laser +cutter. Strokes are chained and ordered by nearest neighbour to minimise idle +travel of the laser head (on a 300 x 200 mm rectangle, idle travel drops from +71.7 m to 4.2 m). + +Works on paths, rectangles, circles, ellipses and polygons, also inside +groups, with holes respected. Settings: period (line spacing), line width, +margin from the edge, unit, iterations (few: dots and short lines; many: long +regular lines), random seed, and edge behaviour (lines cut like fabric, or +running along the edge). The result is placed in a group above each shape. + +Menu: Extensions > AlexDesign > Dog Bandana Pattern Fill. +Interface in English and French. No extra dependency: uses inkex and numpy, +shipped with Inkscape. Tested with Inkscape 1.4. +License: GPL-2.0-or-later. +``` + +## 6. Demander la relecture + +Message sur le canal RocketChat **inkscape_extensions** +(https://chat.inkscape.org/channel/inkscape_extensions), par exemple : + +```text +Hello! I uploaded "Dog Bandana Pattern Fill" (version 1.0.0) to the extensions +gallery and would like to request a review. It fills shapes with a Turing maze +drawn as round-capped center lines, for laser engraving. Pure Python +(inkex + numpy), GPL-2.0-or-later, pytest suite included in the repository: +https://git.alex-design.fr/Alex/inkscape.motif.DogBandana +Gallery page: +Thanks! +``` diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..b8f9fbf --- /dev/null +++ b/README.en.md @@ -0,0 +1,67 @@ +# Dog Bandana Pattern Fill — Inkscape extension + +Inkscape 1.x extension that fills the selected shapes with a **Turing maze**: +winding lines of constant width that branch, sometimes close into loops, and +end in round tips — the "noodle" pattern often seen on dog bandanas. + +The pattern is computed (Swift-Hohenberg equation, labyrinth regime) on a grid +covering the shape, then reduced to the **center line** of each band: a single +round-capped stroke per noodle, ready for line engraving on a laser cutter, in +an order that limits the idle travel of the laser head. + +![Parameters](images/parameters_en.png) + +## Features + +- Fills paths, rectangles, circles, ellipses and polygons, also inside groups + (transforms included); holes are respected (even-odd rule). +- One `` per shape, `stroke-linecap:round`; the whole stroke (round tips + included) stays inside the shape, minus the margin. +- At the shape edge: lines **cut** like a piece of fabric (default), or lines + that **follow** the edge. +- Adjustable look: few iterations give dots and short lines, many give long + regular lines; the random seed changes the drawing, not its look. Same seed, + same result. +- Optimized engraving order: touching strokes are chained, then ordered by + nearest neighbour. On a 300 × 200 mm rectangle (4 mm period), idle travel + drops from 71,690 mm to 4,179 mm. Disable the reoptimization of your laser + software (LightBurn…) to keep this order. +- About 1 s for 150 × 100 mm, 4 s for 300 × 200 mm (4 mm period). +- Interface in English and French, following Inkscape's language. + +## Installation + +No external dependency: the extension uses `inkex` and `numpy`, shipped with +Inkscape. + +- **Extension Manager**: *Extensions › Manage Extensions…*, second tab, folder + button at the bottom, pick the zip. +- **By hand**: unzip into a subfolder of the user extensions folder + (*Edit › Preferences › System › User extensions*), then restart Inkscape. + +## Usage + +1. Select one or more closed shapes (or groups). +2. *Extensions › AlexDesign › Dog Bandana Pattern Fill*. +3. Set period, line width, margin, iterations, seed and edge behaviour in the + **Pattern** tab, color and "keep the original shape" in **Style**. +4. Apply: the pattern is placed in a group just above each shape. + +| Parameter | Default | Role | +| ------------------ | ------------------ | ------------------------------------------------------- | +| Period | 4 mm | Distance between the centers of two neighbouring lines | +| Line width | 2 mm | Stroke width; must stay below the period | +| Margin | 0 | Free space between the shape edge and the strokes | +| Unit | mm | mm, cm, px, pt, in | +| Iterations | 60 | Few: dots and short lines; many: long regular lines | +| Random seed | 1 | Changes the drawing, not its look | +| At the shape edge | Cut the lines | Cut like fabric, or follow the edge | +| Line color | black | Stroke color and opacity | +| Keep the original | yes | Otherwise the source shape is deleted | + +## License + +GPL-2.0-or-later — see [LICENSE](LICENSE). + +Source code, tests and French documentation: +https://git.alex-design.fr/Alex/inkscape.motif.DogBandana diff --git a/README.md b/README.md index 4839c78..a2832f4 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ ligne, dans un ordre qui limite les déplacements à vide de la tête. - [Paramètres](#paramètres) - [Structure du projet](#structure-du-projet) - [Développement](#développement) +- [Licence](#licence) ## Fonctionnalités @@ -137,11 +138,16 @@ locale/ Traductions compilées (.mo), déployées images/parameters_en.png Schéma de l'onglet « Help » (déployé) docs/schema_parametres.py Générateur du schéma (fr pour le README, en pour le dialogue) docs/parametres.png Schéma du README -docs/apercu.png Aperçu du résultat (bandeau du README) +docs/apercu.png Aperçu du résultat (bandeau du README, capture inkscape.org) +docs/make_icon.py Générateur de l'icône de la galerie (docs/icon.png) docs/*.jpg Image de référence du motif tests/data/ Formes d'exemple (dont une page à l'échelle non standard) test_dog_bandana.py Tests pytest deploy.ps1 Déploiement / désinstallation Windows +package.py Zip à publier sur inkscape.org (dist/) +PUBLICATION.md Marche à suivre pour inkscape.org +README.en.md README anglais (livré dans le zip) +LICENSE GPL-2.0 ``` API du module `dog_bandana_core` : @@ -201,3 +207,21 @@ python docs/schema_parametres.py # fr → docs/parametres.png (1400 px) Les motifs du schéma sont calculés par `dog_bandana_core`, comme dans l'extension. L'export PNG passe par `C:\Program Files\Inkscape\bin\inkscape.com`. + +### Publication sur inkscape.org + +```bash +python docs/make_icon.py # docs/icon.png, icône de la galerie +python package.py # dist/dog_bandana-.zip + .md5 +python package.py --sign # + signature GnuPG détachée (.sig) +``` + +`package.py` vérifie la compatibilité Python 3.8 des fichiers livrés et la +présence des traductions compilées. Marche à suivre complète, description +anglaise à coller et état des exigences : [PUBLICATION.md](PUBLICATION.md). +Les commentaires du code sont en anglais, comme l'exige la relecture +d'inkscape.org. + +## Licence + +GPL-2.0-or-later — voir [LICENSE](LICENSE). diff --git a/dog_bandana.inx b/dog_bandana.inx index 52158ef..98c7cef 100644 --- a/dog_bandana.inx +++ b/dog_bandana.inx @@ -1,8 +1,11 @@ @@ -18,7 +21,7 @@ 0.0 - + @@ -45,13 +48,13 @@ - + images/parameters_en.png - +