Browser and install GUI for cookiecutter templates

โŒˆโŒ‹ โŽ‡ branch:  cookiedough


Check-in [425ba2342d]

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fixed doc references to old search behaviour
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 425ba2342d68877992760cad786bdd000d4f76a046dda1934757fd26c965b54d
User & Date: mario 2021-03-22 18:10:03
Context
2021-03-22
18:11
Removed remnants of previous attempts of search input widget prettification check-in: 0adcc047dd user: mario tags: trunk
18:10
Fixed doc references to old search behaviour check-in: 425ba2342d user: mario tags: trunk
13:49
Document current search (image swap gone, ENTER binding default). check-in: ed9c65f8bc user: mario tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to NEWS.

1
2
3

4

5
6
7
8
9
10
11
12
13
0.1.0 (unreleased)
 * Scoring and sorting of project templates.
 * Graphical prompts for cookiecutter.json variables.

 * More icons, documentation.

 * ...


0.0.7 (2021-03-20)
 * Search and categories implemented.
 * Minimal settings window.
 * More menu options.
 * README, manpages.




>
|
>

<







1
2
3
4
5
6
7

8
9
10
11
12
13
14
0.1.0 (unreleased)
 * Scoring and sorting of project templates.
 * Graphical prompts for cookiecutter.json variables.
 * More icons. Simpler search box prettification.
 * More wiki/yelp documentation.
 * Patch for cookiecutter ~/.config/ support.
 * ...


0.0.7 (2021-03-20)
 * Search and categories implemented.
 * Minimal settings window.
 * More menu options.
 * README, manpages.

Changes to cookiedough/update.py.

80
81
82
83
84
85
86





87
88
89
90
91
92
93
        bonus += 0.75
    if d["has_wiki"]:
        bonus += 0.5
    if was_curated(d["name"]):
        bonus += 0.8
    if conf.get("score.find"):
       score["find"] = 0.5 * len(re.findall(conf["score.find"], d["dir"]+"\n"+d["readme"], re.X))






    # combined values
    score["bonus"] = bonus
    score["all"] = sum(score.values())
    d["score"] = score
    #print(d["name"], " =>  ", d["score"]["all"])








>
>
>
>
>







80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
        bonus += 0.75
    if d["has_wiki"]:
        bonus += 0.5
    if was_curated(d["name"]):
        bonus += 0.8
    if conf.get("score.find"):
       score["find"] = 0.5 * len(re.findall(conf["score.find"], d["dir"]+"\n"+d["readme"], re.X))
       
    #@todo
    # ยท points for @example.com
    # ยท downvotes for `e.g.`
    # ยท or incomplete url examples

    # combined values
    score["bonus"] = bonus
    score["all"] = sum(score.values())
    d["score"] = score
    #print(d["name"], " =>  ", d["score"]["all"])

Changes to manpage/cookiecutter.1.

225
226
227
228
229
230
231
232
233
234
235
236
237

238

239
240
241
242
243
244
245
246
247
248
249
250
251
PyPI: https://pypi.python.org/pypi/cookiecutter
.SH FILES
.TP
.B \f[B]\[ti]/.cookiecutterrc\f[R]
config store
.TP
.B \f[B]\[ti]/.cookiecutters/\f[R]
cache dir?
.PP
These default paths are not XDG\-compliant
(https://github.com/cookiecutter/cookiecutter/issues/104).
.PP
It\[cq]s planned that \f[B]cookiedough\f[R](1) overrides those settings,

or perhaps even silently moves + symlinks the cache dir and config file.

.SH ENV
.TP
.B \f[B]COOKIECUTTER_CONFIG\f[R]
Location of YAML file to use in place of
\f[C]\[ti]/.cookiecutterrc\f[R].
Can also be specified per \f[I]\-\-config\-file\f[R] option.
.SH SEE ALSO
.PP
\f[B]cookiedough\f[R](1), \f[B]python3\f[R](1)
.SH AUTHORS
cookiecutter project (audreyfeldroy, freakboy3742, stevepiercy,
terryjbates, pokoli, saxix, hackebrot, pfmoore, macrotim, kmike,
foobacca, luzfcb, ivanovmg), (c) MITL.







|



<
|
>
|
>













225
226
227
228
229
230
231
232
233
234
235

236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
PyPI: https://pypi.python.org/pypi/cookiecutter
.SH FILES
.TP
.B \f[B]\[ti]/.cookiecutterrc\f[R]
config store
.TP
.B \f[B]\[ti]/.cookiecutters/\f[R]
cache dir
.PP
These default paths are not XDG\-compliant
(https://github.com/cookiecutter/cookiecutter/issues/104).

\f[B]cookiedough\f[R](1) always overrides those settings, but also
provides a patch to permanently fix the builtin defaults to
\f[B]~/.config/cookiecutter/config\f[R] and
\f[B]~/.cache/cookiecutters/\f[R] respectively.
.SH ENV
.TP
.B \f[B]COOKIECUTTER_CONFIG\f[R]
Location of YAML file to use in place of
\f[C]\[ti]/.cookiecutterrc\f[R].
Can also be specified per \f[I]\-\-config\-file\f[R] option.
.SH SEE ALSO
.PP
\f[B]cookiedough\f[R](1), \f[B]python3\f[R](1)
.SH AUTHORS
cookiecutter project (audreyfeldroy, freakboy3742, stevepiercy,
terryjbates, pokoli, saxix, hackebrot, pfmoore, macrotim, kmike,
foobacca, luzfcb, ivanovmg), (c) MITL.

Changes to manpage/cookiecutter.md.

209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

224
225
226
227
228
229
230
=====


**~/.cookiecutterrc**
 : config store

**~/.cookiecutters/**
 : cache dir?

These default paths are not XDG-compliant
(https://github.com/cookiecutter/cookiecutter/issues/104).

It's planned that **cookiedough**(1) overrides those settings,
or perhaps even silently moves + symlinks the cache dir and
config file.



ENV
===

**COOKIECUTTER_CONFIG**
 : Location of YAML file to use in place of `~/.cookiecutterrc`.  







|



|
|
<
|
>







209
210
211
212
213
214
215
216
217
218
219
220
221

222
223
224
225
226
227
228
229
230
=====


**~/.cookiecutterrc**
 : config store

**~/.cookiecutters/**
 : cache dir

These default paths are not XDG-compliant
(https://github.com/cookiecutter/cookiecutter/issues/104).
**cookiedough**(1) always overrides those settings, but also
provides a patch to permanently fix the builtin defaults

to **~/.config/cookiecutter/config**
and **~/.cache/cookiecutters/** respectively.


ENV
===

**COOKIECUTTER_CONFIG**
 : Location of YAML file to use in place of `~/.cookiecutterrc`.  

Changes to manpage/cookiedough.1.

19
20
21
22
23
24
25
26
27
28
29

30
31
32
33
34
35
36
.IP \[bu] 2
Expand one of the categories in the left pane to see available
templates.
.IP \[bu] 2
Click to see expanded details on right pane.
.SS Search
.IP \[bu] 2
Click the search field, then perhaps select the real search field again.
.IP \[bu] 2
Any typing will trigger an update to the template list.
(Might fix this in a later release.)

.IP \[bu] 2
You might want to search for common keywords in the description, or even
filenames (\f[C]pyproject.toml setup.cfg\f[R] etc.) to find matching
cookiecutters.
.SS Install
.IP \[bu] 2
Push the [Roll out] button top right.







|

|
|
>







19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
.IP \[bu] 2
Expand one of the categories in the left pane to see available
templates.
.IP \[bu] 2
Click to see expanded details on right pane.
.SS Search
.IP \[bu] 2
The search field is located top left, and allows to filter templates.
.IP \[bu] 2
Meanwhile any update happens once you hit ENTER while the search box is
selected.
(Old mode / instant search is configurable, but slow.)
.IP \[bu] 2
You might want to search for common keywords in the description, or even
filenames (\f[C]pyproject.toml setup.cfg\f[R] etc.) to find matching
cookiecutters.
.SS Install
.IP \[bu] 2
Push the [Roll out] button top right.
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<https://fossil.include-once.org/cookiedough/wcontent>
.SH FILES
.TP
.B \f[B]\[ti]/.config/cookiedough/\f[R]
Application config files, specifically \f[I]settings.json\f[R].
Future versions
might also pack some \f[B]cookiecutter\f[R](1) yaml config file in here.
(Whereas the cache : would go into \f[I]\[ti]/.cache/\&...\f[R]).
.SH ENV
.TP
.B \f[B]XDG_CONFIG_HOME\f[R]
base dir location for app config storage
.TP
.B \f[B]GITHUB_API_TOKEN\f[R]
might or might not be used by update functionality
.SH SEE ALSO
.PP
\f[B]cookiecutter\f[R](1), \f[B]python3\f[R](1)







|










64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<https://fossil.include-once.org/cookiedough/wcontent>
.SH FILES
.TP
.B \f[B]\[ti]/.config/cookiedough/\f[R]
Application config files, specifically \f[I]settings.json\f[R].
Future versions
might also pack some \f[B]cookiecutter\f[R](1) yaml config file in here.
(Whereas the cache would go into \f[I]\[ti]/.cache/\&...\f[R]).
.SH ENV
.TP
.B \f[B]XDG_CONFIG_HOME\f[R]
base dir location for app config storage
.TP
.B \f[B]GITHUB_API_TOKEN\f[R]
might or might not be used by update functionality
.SH SEE ALSO
.PP
\f[B]cookiecutter\f[R](1), \f[B]python3\f[R](1)

Changes to manpage/cookiedough.md.

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

 * Expand one of the categories in the left pane to see available templates.
 * Click to see expanded details on right pane.

Search
------

 * Click the search field, then perhaps select the real search field again.
 * Any typing will trigger an update to the template list. (Might fix this
   in a later release.)
 * You might want to search for common keywords in the description, or
   even filenames (`pyproject.toml setup.cfg` etc.) to find matching
   cookiecutters.

Install
-------








|
|
|







28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

 * Expand one of the categories in the left pane to see available templates.
 * Click to see expanded details on right pane.

Search
------

 * The search field is located top left, and allows to filter templates.
 * Meanwhile any update happens once you hit ENTER while the search box
   is selected. (Old mode / instant search is configurable, but slow.)
 * You might want to search for common keywords in the description, or
   even filenames (`pyproject.toml setup.cfg` etc.) to find matching
   cookiecutters.

Install
-------

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

FILES
=====

**~/.config/cookiedough/**
 : Application config files, specifically *settings.json*.  Future versions
 : might also pack some **cookiecutter**(1) yaml config file in here. 
 : (Whereas the cache : would go into *~/.cache/...*).

ENV
===

**XDG_CONFIG_HOME**
 : base dir location for app config storage








|







73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

FILES
=====

**~/.config/cookiedough/**
 : Application config files, specifically *settings.json*.  Future versions
 : might also pack some **cookiecutter**(1) yaml config file in here. 
 : (Whereas the cache would go into *~/.cache/...*).

ENV
===

**XDG_CONFIG_HOME**
 : base dir location for app config storage