recettes 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- recettes-1.0.0/.github/workflows/cd.yaml +33 -0
- recettes-1.0.0/.github/workflows/ci.yml +26 -0
- recettes-1.0.0/.github/workflows/publish.yml +47 -0
- recettes-1.0.0/.gitignore +9 -0
- recettes-1.0.0/LICENSE +121 -0
- recettes-1.0.0/PKG-INFO +232 -0
- recettes-1.0.0/README.md +87 -0
- recettes-1.0.0/examples/buckwheat-crepes.md +12 -0
- recettes-1.0.0/examples/caramel.md +25 -0
- recettes-1.0.0/examples/crackers.md +33 -0
- recettes-1.0.0/examples/granola.md +30 -0
- recettes-1.0.0/examples/julia-cookies.md +39 -0
- recettes-1.0.0/examples/lemon-ginger-syrup-1.jpeg +0 -0
- recettes-1.0.0/examples/lemon-ginger-syrup-2.jpeg +0 -0
- recettes-1.0.0/examples/lemon-ginger-syrup-3.jpeg +0 -0
- recettes-1.0.0/examples/lemon-ginger-syrup-4.jpeg +0 -0
- recettes-1.0.0/examples/lemon-ginger-syrup.md +26 -0
- recettes-1.0.0/examples/lemon-tart.md +35 -0
- recettes-1.0.0/examples/onion-soup.md +49 -0
- recettes-1.0.0/examples/walnut-cake.md +28 -0
- recettes-1.0.0/pyproject.toml +46 -0
- recettes-1.0.0/setup.cfg +4 -0
- recettes-1.0.0/src/recettes/__init__.py +1 -0
- recettes-1.0.0/src/recettes/cli.py +395 -0
- recettes-1.0.0/src/recettes/static/app.js +77 -0
- recettes-1.0.0/src/recettes/static/recipe.js +29 -0
- recettes-1.0.0/src/recettes/static/style.css +460 -0
- recettes-1.0.0/src/recettes/templates/index.html +49 -0
- recettes-1.0.0/src/recettes/templates/recipe.html +44 -0
- recettes-1.0.0/src/recettes.egg-info/PKG-INFO +232 -0
- recettes-1.0.0/src/recettes.egg-info/SOURCES.txt +37 -0
- recettes-1.0.0/src/recettes.egg-info/dependency_links.txt +1 -0
- recettes-1.0.0/src/recettes.egg-info/entry_points.txt +2 -0
- recettes-1.0.0/src/recettes.egg-info/requires.txt +7 -0
- recettes-1.0.0/src/recettes.egg-info/scm_file_list.json +33 -0
- recettes-1.0.0/src/recettes.egg-info/scm_version.json +8 -0
- recettes-1.0.0/src/recettes.egg-info/top_level.txt +1 -0
- recettes-1.0.0/tests/test_build.py +122 -0
- recettes-1.0.0/uv.lock +539 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
name: Publish recipe website to GitHub Pages
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: write
|
|
10
|
+
|
|
11
|
+
concurrency:
|
|
12
|
+
group: github-pages
|
|
13
|
+
cancel-in-progress: true
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
publish:
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v4
|
|
20
|
+
- uses: actions/setup-python@v5
|
|
21
|
+
with:
|
|
22
|
+
python-version: "3.12"
|
|
23
|
+
- uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
|
|
24
|
+
- name: Install Recettes
|
|
25
|
+
run: uv sync --locked --no-dev
|
|
26
|
+
- name: Build recipe website
|
|
27
|
+
run: uv run --locked recettes build examples --destination site --title "My Recipes"
|
|
28
|
+
- name: Publish to gh-pages
|
|
29
|
+
uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
|
|
30
|
+
with:
|
|
31
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
32
|
+
publish_branch: gh-pages
|
|
33
|
+
publish_dir: ./site
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
pull_request:
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
lint-and-test:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- uses: actions/setup-python@v5
|
|
16
|
+
with:
|
|
17
|
+
python-version: "3.12"
|
|
18
|
+
- uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
|
|
19
|
+
- name: Install project and development tools
|
|
20
|
+
run: uv sync --locked --extra dev
|
|
21
|
+
- name: Lint with Ruff
|
|
22
|
+
run: uv run --locked ruff check .
|
|
23
|
+
- name: Run tests
|
|
24
|
+
run: uv run --locked pytest
|
|
25
|
+
- name: Check JavaScript and CSS formatting
|
|
26
|
+
run: npx --yes prettier@3.6.2 --check "src/recettes/static/**/*.{js,css}"
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
name: Publish Python 🐍 distribution 📦 to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- '*'
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
name: Build distribution 📦
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v6
|
|
15
|
+
with:
|
|
16
|
+
fetch-depth: 0
|
|
17
|
+
|
|
18
|
+
- uses: astral-sh/setup-uv@v7
|
|
19
|
+
|
|
20
|
+
- name: Build a binary wheel and a source tarball
|
|
21
|
+
run: uv build
|
|
22
|
+
|
|
23
|
+
- name: Store the distribution packages
|
|
24
|
+
uses: actions/upload-artifact@v7
|
|
25
|
+
with:
|
|
26
|
+
name: python-package-distributions
|
|
27
|
+
path: dist/
|
|
28
|
+
|
|
29
|
+
publish-to-pypi:
|
|
30
|
+
name: Publish Python 🐍 distribution 📦 to PyPI
|
|
31
|
+
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
|
|
32
|
+
needs:
|
|
33
|
+
- build
|
|
34
|
+
runs-on: ubuntu-latest
|
|
35
|
+
environment:
|
|
36
|
+
name: release
|
|
37
|
+
url: https://pypi.org/p/recettes
|
|
38
|
+
permissions:
|
|
39
|
+
id-token: write
|
|
40
|
+
steps:
|
|
41
|
+
- name: Download all the dists
|
|
42
|
+
uses: actions/download-artifact@v8
|
|
43
|
+
with:
|
|
44
|
+
name: python-package-distributions
|
|
45
|
+
path: dist/
|
|
46
|
+
- name: Publish distribution 📦 to PyPI
|
|
47
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
recettes-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
Creative Commons Legal Code
|
|
2
|
+
|
|
3
|
+
CC0 1.0 Universal
|
|
4
|
+
|
|
5
|
+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
|
6
|
+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
|
7
|
+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
|
8
|
+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
|
9
|
+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
|
10
|
+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
|
11
|
+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
|
12
|
+
HEREUNDER.
|
|
13
|
+
|
|
14
|
+
Statement of Purpose
|
|
15
|
+
|
|
16
|
+
The laws of most jurisdictions throughout the world automatically confer
|
|
17
|
+
exclusive Copyright and Related Rights (defined below) upon the creator
|
|
18
|
+
and subsequent owner(s) (each and all, an "owner") of an original work of
|
|
19
|
+
authorship and/or a database (each, a "Work").
|
|
20
|
+
|
|
21
|
+
Certain owners wish to permanently relinquish those rights to a Work for
|
|
22
|
+
the purpose of contributing to a commons of creative, cultural and
|
|
23
|
+
scientific works ("Commons") that the public can reliably and without fear
|
|
24
|
+
of later claims of infringement build upon, modify, incorporate in other
|
|
25
|
+
works, reuse and redistribute as freely as possible in any form whatsoever
|
|
26
|
+
and for any purposes, including without limitation commercial purposes.
|
|
27
|
+
These owners may contribute to the Commons to promote the ideal of a free
|
|
28
|
+
culture and the further production of creative, cultural and scientific
|
|
29
|
+
works, or to gain reputation or greater distribution for their Work in
|
|
30
|
+
part through the use and efforts of others.
|
|
31
|
+
|
|
32
|
+
For these and/or other purposes and motivations, and without any
|
|
33
|
+
expectation of additional consideration or compensation, the person
|
|
34
|
+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
|
35
|
+
is an owner of Copyright and Related Rights in the Work, voluntarily
|
|
36
|
+
elects to apply CC0 to the Work and publicly distribute the Work under its
|
|
37
|
+
terms, with knowledge of his or her Copyright and Related Rights in the
|
|
38
|
+
Work and the meaning and intended legal effect of CC0 on those rights.
|
|
39
|
+
|
|
40
|
+
1. Copyright and Related Rights. A Work made available under CC0 may be
|
|
41
|
+
protected by copyright and related or neighboring rights ("Copyright and
|
|
42
|
+
Related Rights"). Copyright and Related Rights include, but are not
|
|
43
|
+
limited to, the following:
|
|
44
|
+
|
|
45
|
+
i. the right to reproduce, adapt, distribute, perform, display,
|
|
46
|
+
communicate, and translate a Work;
|
|
47
|
+
ii. moral rights retained by the original author(s) and/or performer(s);
|
|
48
|
+
iii. publicity and privacy rights pertaining to a person's image or
|
|
49
|
+
likeness depicted in a Work;
|
|
50
|
+
iv. rights protecting against unfair competition in regards to a Work,
|
|
51
|
+
subject to the limitations in paragraph 4(a), below;
|
|
52
|
+
v. rights protecting the extraction, dissemination, use and reuse of data
|
|
53
|
+
in a Work;
|
|
54
|
+
vi. database rights (such as those arising under Directive 96/9/EC of the
|
|
55
|
+
European Parliament and of the Council of 11 March 1996 on the legal
|
|
56
|
+
protection of databases, and under any national implementation
|
|
57
|
+
thereof, including any amended or successor version of such
|
|
58
|
+
directive); and
|
|
59
|
+
vii. other similar, equivalent or corresponding rights throughout the
|
|
60
|
+
world based on applicable law or treaty, and any national
|
|
61
|
+
implementations thereof.
|
|
62
|
+
|
|
63
|
+
2. Waiver. To the greatest extent permitted by, but not in contravention
|
|
64
|
+
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
|
65
|
+
irrevocably and unconditionally waives, abandons, and surrenders all of
|
|
66
|
+
Affirmer's Copyright and Related Rights and associated claims and causes
|
|
67
|
+
of action, whether now known or unknown (including existing as well as
|
|
68
|
+
future claims and causes of action), in the Work (i) in all territories
|
|
69
|
+
worldwide, (ii) for the maximum duration provided by applicable law or
|
|
70
|
+
treaty (including future time extensions), (iii) in any current or future
|
|
71
|
+
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
|
72
|
+
including without limitation commercial, advertising or promotional
|
|
73
|
+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
|
74
|
+
member of the public at large and to the detriment of Affirmer's heirs and
|
|
75
|
+
successors, fully intending that such Waiver shall not be subject to
|
|
76
|
+
revocation, rescission, cancellation, termination, or any other legal or
|
|
77
|
+
equitable action to disrupt the quiet enjoyment of the Work by the public
|
|
78
|
+
as contemplated by Affirmer's express Statement of Purpose.
|
|
79
|
+
|
|
80
|
+
3. Public License Fallback. Should any part of the Waiver for any reason
|
|
81
|
+
be judged legally invalid or ineffective under applicable law, then the
|
|
82
|
+
Waiver shall be preserved to the maximum extent permitted taking into
|
|
83
|
+
account Affirmer's express Statement of Purpose. In addition, to the
|
|
84
|
+
extent the Waiver is so judged Affirmer hereby grants to each affected
|
|
85
|
+
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
|
86
|
+
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
|
87
|
+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
|
88
|
+
maximum duration provided by applicable law or treaty (including future
|
|
89
|
+
time extensions), (iii) in any current or future medium and for any number
|
|
90
|
+
of copies, and (iv) for any purpose whatsoever, including without
|
|
91
|
+
limitation commercial, advertising or promotional purposes (the
|
|
92
|
+
"License"). The License shall be deemed effective as of the date CC0 was
|
|
93
|
+
applied by Affirmer to the Work. Should any part of the License for any
|
|
94
|
+
reason be judged legally invalid or ineffective under applicable law, such
|
|
95
|
+
partial invalidity or ineffectiveness shall not invalidate the remainder
|
|
96
|
+
of the License, and in such case Affirmer hereby affirms that he or she
|
|
97
|
+
will not (i) exercise any of his or her remaining Copyright and Related
|
|
98
|
+
Rights in the Work or (ii) assert any associated claims and causes of
|
|
99
|
+
action with respect to the Work, in either case contrary to Affirmer's
|
|
100
|
+
express Statement of Purpose.
|
|
101
|
+
|
|
102
|
+
4. Limitations and Disclaimers.
|
|
103
|
+
|
|
104
|
+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
|
105
|
+
surrendered, licensed or otherwise affected by this document.
|
|
106
|
+
b. Affirmer offers the Work as-is and makes no representations or
|
|
107
|
+
warranties of any kind concerning the Work, express, implied,
|
|
108
|
+
statutory or otherwise, including without limitation warranties of
|
|
109
|
+
title, merchantability, fitness for a particular purpose, non
|
|
110
|
+
infringement, or the absence of latent or other defects, accuracy, or
|
|
111
|
+
the present or absence of errors, whether or not discoverable, all to
|
|
112
|
+
the greatest extent permissible under applicable law.
|
|
113
|
+
c. Affirmer disclaims responsibility for clearing rights of other persons
|
|
114
|
+
that may apply to the Work or any use thereof, including without
|
|
115
|
+
limitation any person's Copyright and Related Rights in the Work.
|
|
116
|
+
Further, Affirmer disclaims responsibility for obtaining any necessary
|
|
117
|
+
consents, permissions or other rights required for any use of the
|
|
118
|
+
Work.
|
|
119
|
+
d. Affirmer understands and acknowledges that Creative Commons is not a
|
|
120
|
+
party to this document and has no duty or obligation with respect to
|
|
121
|
+
this CC0 or use of the Work.
|
recettes-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: recettes
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Build a static recipe website from Markdown files.
|
|
5
|
+
Author: Mathieu Leplatre
|
|
6
|
+
License: Creative Commons Legal Code
|
|
7
|
+
|
|
8
|
+
CC0 1.0 Universal
|
|
9
|
+
|
|
10
|
+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
|
|
11
|
+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
|
|
12
|
+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
|
|
13
|
+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
|
|
14
|
+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
|
|
15
|
+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
|
|
16
|
+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
|
|
17
|
+
HEREUNDER.
|
|
18
|
+
|
|
19
|
+
Statement of Purpose
|
|
20
|
+
|
|
21
|
+
The laws of most jurisdictions throughout the world automatically confer
|
|
22
|
+
exclusive Copyright and Related Rights (defined below) upon the creator
|
|
23
|
+
and subsequent owner(s) (each and all, an "owner") of an original work of
|
|
24
|
+
authorship and/or a database (each, a "Work").
|
|
25
|
+
|
|
26
|
+
Certain owners wish to permanently relinquish those rights to a Work for
|
|
27
|
+
the purpose of contributing to a commons of creative, cultural and
|
|
28
|
+
scientific works ("Commons") that the public can reliably and without fear
|
|
29
|
+
of later claims of infringement build upon, modify, incorporate in other
|
|
30
|
+
works, reuse and redistribute as freely as possible in any form whatsoever
|
|
31
|
+
and for any purposes, including without limitation commercial purposes.
|
|
32
|
+
These owners may contribute to the Commons to promote the ideal of a free
|
|
33
|
+
culture and the further production of creative, cultural and scientific
|
|
34
|
+
works, or to gain reputation or greater distribution for their Work in
|
|
35
|
+
part through the use and efforts of others.
|
|
36
|
+
|
|
37
|
+
For these and/or other purposes and motivations, and without any
|
|
38
|
+
expectation of additional consideration or compensation, the person
|
|
39
|
+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
|
|
40
|
+
is an owner of Copyright and Related Rights in the Work, voluntarily
|
|
41
|
+
elects to apply CC0 to the Work and publicly distribute the Work under its
|
|
42
|
+
terms, with knowledge of his or her Copyright and Related Rights in the
|
|
43
|
+
Work and the meaning and intended legal effect of CC0 on those rights.
|
|
44
|
+
|
|
45
|
+
1. Copyright and Related Rights. A Work made available under CC0 may be
|
|
46
|
+
protected by copyright and related or neighboring rights ("Copyright and
|
|
47
|
+
Related Rights"). Copyright and Related Rights include, but are not
|
|
48
|
+
limited to, the following:
|
|
49
|
+
|
|
50
|
+
i. the right to reproduce, adapt, distribute, perform, display,
|
|
51
|
+
communicate, and translate a Work;
|
|
52
|
+
ii. moral rights retained by the original author(s) and/or performer(s);
|
|
53
|
+
iii. publicity and privacy rights pertaining to a person's image or
|
|
54
|
+
likeness depicted in a Work;
|
|
55
|
+
iv. rights protecting against unfair competition in regards to a Work,
|
|
56
|
+
subject to the limitations in paragraph 4(a), below;
|
|
57
|
+
v. rights protecting the extraction, dissemination, use and reuse of data
|
|
58
|
+
in a Work;
|
|
59
|
+
vi. database rights (such as those arising under Directive 96/9/EC of the
|
|
60
|
+
European Parliament and of the Council of 11 March 1996 on the legal
|
|
61
|
+
protection of databases, and under any national implementation
|
|
62
|
+
thereof, including any amended or successor version of such
|
|
63
|
+
directive); and
|
|
64
|
+
vii. other similar, equivalent or corresponding rights throughout the
|
|
65
|
+
world based on applicable law or treaty, and any national
|
|
66
|
+
implementations thereof.
|
|
67
|
+
|
|
68
|
+
2. Waiver. To the greatest extent permitted by, but not in contravention
|
|
69
|
+
of, applicable law, Affirmer hereby overtly, fully, permanently,
|
|
70
|
+
irrevocably and unconditionally waives, abandons, and surrenders all of
|
|
71
|
+
Affirmer's Copyright and Related Rights and associated claims and causes
|
|
72
|
+
of action, whether now known or unknown (including existing as well as
|
|
73
|
+
future claims and causes of action), in the Work (i) in all territories
|
|
74
|
+
worldwide, (ii) for the maximum duration provided by applicable law or
|
|
75
|
+
treaty (including future time extensions), (iii) in any current or future
|
|
76
|
+
medium and for any number of copies, and (iv) for any purpose whatsoever,
|
|
77
|
+
including without limitation commercial, advertising or promotional
|
|
78
|
+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
|
|
79
|
+
member of the public at large and to the detriment of Affirmer's heirs and
|
|
80
|
+
successors, fully intending that such Waiver shall not be subject to
|
|
81
|
+
revocation, rescission, cancellation, termination, or any other legal or
|
|
82
|
+
equitable action to disrupt the quiet enjoyment of the Work by the public
|
|
83
|
+
as contemplated by Affirmer's express Statement of Purpose.
|
|
84
|
+
|
|
85
|
+
3. Public License Fallback. Should any part of the Waiver for any reason
|
|
86
|
+
be judged legally invalid or ineffective under applicable law, then the
|
|
87
|
+
Waiver shall be preserved to the maximum extent permitted taking into
|
|
88
|
+
account Affirmer's express Statement of Purpose. In addition, to the
|
|
89
|
+
extent the Waiver is so judged Affirmer hereby grants to each affected
|
|
90
|
+
person a royalty-free, non transferable, non sublicensable, non exclusive,
|
|
91
|
+
irrevocable and unconditional license to exercise Affirmer's Copyright and
|
|
92
|
+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
|
|
93
|
+
maximum duration provided by applicable law or treaty (including future
|
|
94
|
+
time extensions), (iii) in any current or future medium and for any number
|
|
95
|
+
of copies, and (iv) for any purpose whatsoever, including without
|
|
96
|
+
limitation commercial, advertising or promotional purposes (the
|
|
97
|
+
"License"). The License shall be deemed effective as of the date CC0 was
|
|
98
|
+
applied by Affirmer to the Work. Should any part of the License for any
|
|
99
|
+
reason be judged legally invalid or ineffective under applicable law, such
|
|
100
|
+
partial invalidity or ineffectiveness shall not invalidate the remainder
|
|
101
|
+
of the License, and in such case Affirmer hereby affirms that he or she
|
|
102
|
+
will not (i) exercise any of his or her remaining Copyright and Related
|
|
103
|
+
Rights in the Work or (ii) assert any associated claims and causes of
|
|
104
|
+
action with respect to the Work, in either case contrary to Affirmer's
|
|
105
|
+
express Statement of Purpose.
|
|
106
|
+
|
|
107
|
+
4. Limitations and Disclaimers.
|
|
108
|
+
|
|
109
|
+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
|
|
110
|
+
surrendered, licensed or otherwise affected by this document.
|
|
111
|
+
b. Affirmer offers the Work as-is and makes no representations or
|
|
112
|
+
warranties of any kind concerning the Work, express, implied,
|
|
113
|
+
statutory or otherwise, including without limitation warranties of
|
|
114
|
+
title, merchantability, fitness for a particular purpose, non
|
|
115
|
+
infringement, or the absence of latent or other defects, accuracy, or
|
|
116
|
+
the present or absence of errors, whether or not discoverable, all to
|
|
117
|
+
the greatest extent permissible under applicable law.
|
|
118
|
+
c. Affirmer disclaims responsibility for clearing rights of other persons
|
|
119
|
+
that may apply to the Work or any use thereof, including without
|
|
120
|
+
limitation any person's Copyright and Related Rights in the Work.
|
|
121
|
+
Further, Affirmer disclaims responsibility for obtaining any necessary
|
|
122
|
+
consents, permissions or other rights required for any use of the
|
|
123
|
+
Work.
|
|
124
|
+
d. Affirmer understands and acknowledges that Creative Commons is not a
|
|
125
|
+
party to this document and has no duty or obligation with respect to
|
|
126
|
+
this CC0 or use of the Work.
|
|
127
|
+
|
|
128
|
+
Project-URL: Repository, https://github.com/leplatrem/python-recettes
|
|
129
|
+
Keywords: recipes,markdown,static site
|
|
130
|
+
Classifier: Programming Language :: Python
|
|
131
|
+
Classifier: Programming Language :: Python :: 3
|
|
132
|
+
Classifier: Environment :: Console
|
|
133
|
+
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
134
|
+
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
|
|
135
|
+
Requires-Python: >=3.10
|
|
136
|
+
Description-Content-Type: text/markdown
|
|
137
|
+
License-File: LICENSE
|
|
138
|
+
Requires-Dist: typer>=0.12
|
|
139
|
+
Requires-Dist: python-frontmatter>=1.1
|
|
140
|
+
Requires-Dist: markdown-it-py>=3
|
|
141
|
+
Provides-Extra: dev
|
|
142
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
143
|
+
Requires-Dist: ruff>=0.6; extra == "dev"
|
|
144
|
+
Dynamic: license-file
|
|
145
|
+
|
|
146
|
+
# Recettes
|
|
147
|
+
|
|
148
|
+
*Recettes* turns Markdown files into a small, static recipe website. Recipes remain easy to edit in GitHub; the generated site is mobile-friendly and needs no application server.
|
|
149
|
+
|
|
150
|
+
## [Example](https://leplatrem.github.io/python-recettes/)
|
|
151
|
+
|
|
152
|
+
Look at the [examples/](./examples/) folder and how it turned into [this website](https://leplatrem.github.io/python-recettes/).
|
|
153
|
+
|
|
154
|
+
## Recipe format
|
|
155
|
+
|
|
156
|
+
Put one Markdown file per recipe in a directory. Optional photos sit beside the Markdown file and use its filename with a numbered suffix:
|
|
157
|
+
|
|
158
|
+
```text
|
|
159
|
+
examples/
|
|
160
|
+
├── onion-soup.md
|
|
161
|
+
├── onion-soup-1.jpg
|
|
162
|
+
└── onion-soup-2.webp
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Recipe properties go in YAML front matter. Tags can be a comma-separated string or a YAML list. All properties are optional:
|
|
166
|
+
|
|
167
|
+
```md
|
|
168
|
+
---
|
|
169
|
+
title: Onion Soup
|
|
170
|
+
portions: 4
|
|
171
|
+
preparation: 45
|
|
172
|
+
cooking: 15
|
|
173
|
+
tags: winter, soup, easy, budget-friendly
|
|
174
|
+
lang: en
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
# Preparation
|
|
178
|
+
|
|
179
|
+
Peel and thinly slice {{ 4 onions }}.
|
|
180
|
+
|
|
181
|
+
Cook them gently in {{ 50g of butter }} and {{ 1 tbsp of oil }}.
|
|
182
|
+
Add {{ 1L of hot water }} and {{ 250ml of white wine }}.
|
|
183
|
+
|
|
184
|
+
Simmer gently until tender.
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Write ingredient amounts inside `{{ }}` in the recipe text.
|
|
188
|
+
|
|
189
|
+
*Recettes* reads a number and an optional unit from the start of each expression, including decimals and fractions such as `0.5cac` and `1/2 cac`. Supported units include metric abbreviations, `tbsp`/`tablespoon(s)`, `tsp`/`teaspoon(s)`, `cup(s)`, `oz`/`ounce(s)`, and `lb`/`pound(s)`. A number without a unit is treated as a count. Text without a leading number is kept as written.
|
|
190
|
+
|
|
191
|
+
The optional `portions` property enables serving controls, and `lang` sets the recipe page's language for browsers and assistive technology.
|
|
192
|
+
|
|
193
|
+
## Create your own website
|
|
194
|
+
|
|
195
|
+
To create your own recipe website, [fork](https://docs.github.com/articles/fork-a-repo) [Mat's recipes repository](https://github.com/leplatrem/recettes/) and replace the recipes in the `recipes/` folder with your own.
|
|
196
|
+
|
|
197
|
+
## Run locally
|
|
198
|
+
|
|
199
|
+
Install from PyPI with [uv](https://docs.astral.sh/uv/):
|
|
200
|
+
|
|
201
|
+
```sh
|
|
202
|
+
uv tool install recettes
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
Or from a checkout, with `uv tool install .`.
|
|
206
|
+
|
|
207
|
+
Build the recipes in a directory and preview the generated site:
|
|
208
|
+
|
|
209
|
+
```sh
|
|
210
|
+
recettes build examples/ --destination site/ --title "My Recipes"
|
|
211
|
+
python -m http.server --directory site/ 8000
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
Open <http://127.0.0.1:8000>.
|
|
215
|
+
|
|
216
|
+
## Development
|
|
217
|
+
|
|
218
|
+
```sh
|
|
219
|
+
uv sync --extra dev
|
|
220
|
+
uv run recettes --help
|
|
221
|
+
uv run ruff check .
|
|
222
|
+
uv run pytest
|
|
223
|
+
npx prettier@3.6.2 --check "src/recettes/static/**/*.{js,css}"
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## Release
|
|
227
|
+
|
|
228
|
+
The version comes from the Git tag. Creating a [new release](https://github.com/leplatrem/python-recettes/releases/) will build the package and publish it to PyPI.
|
|
229
|
+
|
|
230
|
+
## License
|
|
231
|
+
|
|
232
|
+
CC0 1.0 Universal
|
recettes-1.0.0/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Recettes
|
|
2
|
+
|
|
3
|
+
*Recettes* turns Markdown files into a small, static recipe website. Recipes remain easy to edit in GitHub; the generated site is mobile-friendly and needs no application server.
|
|
4
|
+
|
|
5
|
+
## [Example](https://leplatrem.github.io/python-recettes/)
|
|
6
|
+
|
|
7
|
+
Look at the [examples/](./examples/) folder and how it turned into [this website](https://leplatrem.github.io/python-recettes/).
|
|
8
|
+
|
|
9
|
+
## Recipe format
|
|
10
|
+
|
|
11
|
+
Put one Markdown file per recipe in a directory. Optional photos sit beside the Markdown file and use its filename with a numbered suffix:
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
examples/
|
|
15
|
+
├── onion-soup.md
|
|
16
|
+
├── onion-soup-1.jpg
|
|
17
|
+
└── onion-soup-2.webp
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Recipe properties go in YAML front matter. Tags can be a comma-separated string or a YAML list. All properties are optional:
|
|
21
|
+
|
|
22
|
+
```md
|
|
23
|
+
---
|
|
24
|
+
title: Onion Soup
|
|
25
|
+
portions: 4
|
|
26
|
+
preparation: 45
|
|
27
|
+
cooking: 15
|
|
28
|
+
tags: winter, soup, easy, budget-friendly
|
|
29
|
+
lang: en
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# Preparation
|
|
33
|
+
|
|
34
|
+
Peel and thinly slice {{ 4 onions }}.
|
|
35
|
+
|
|
36
|
+
Cook them gently in {{ 50g of butter }} and {{ 1 tbsp of oil }}.
|
|
37
|
+
Add {{ 1L of hot water }} and {{ 250ml of white wine }}.
|
|
38
|
+
|
|
39
|
+
Simmer gently until tender.
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Write ingredient amounts inside `{{ }}` in the recipe text.
|
|
43
|
+
|
|
44
|
+
*Recettes* reads a number and an optional unit from the start of each expression, including decimals and fractions such as `0.5cac` and `1/2 cac`. Supported units include metric abbreviations, `tbsp`/`tablespoon(s)`, `tsp`/`teaspoon(s)`, `cup(s)`, `oz`/`ounce(s)`, and `lb`/`pound(s)`. A number without a unit is treated as a count. Text without a leading number is kept as written.
|
|
45
|
+
|
|
46
|
+
The optional `portions` property enables serving controls, and `lang` sets the recipe page's language for browsers and assistive technology.
|
|
47
|
+
|
|
48
|
+
## Create your own website
|
|
49
|
+
|
|
50
|
+
To create your own recipe website, [fork](https://docs.github.com/articles/fork-a-repo) [Mat's recipes repository](https://github.com/leplatrem/recettes/) and replace the recipes in the `recipes/` folder with your own.
|
|
51
|
+
|
|
52
|
+
## Run locally
|
|
53
|
+
|
|
54
|
+
Install from PyPI with [uv](https://docs.astral.sh/uv/):
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
uv tool install recettes
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Or from a checkout, with `uv tool install .`.
|
|
61
|
+
|
|
62
|
+
Build the recipes in a directory and preview the generated site:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
recettes build examples/ --destination site/ --title "My Recipes"
|
|
66
|
+
python -m http.server --directory site/ 8000
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Open <http://127.0.0.1:8000>.
|
|
70
|
+
|
|
71
|
+
## Development
|
|
72
|
+
|
|
73
|
+
```sh
|
|
74
|
+
uv sync --extra dev
|
|
75
|
+
uv run recettes --help
|
|
76
|
+
uv run ruff check .
|
|
77
|
+
uv run pytest
|
|
78
|
+
npx prettier@3.6.2 --check "src/recettes/static/**/*.{js,css}"
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Release
|
|
82
|
+
|
|
83
|
+
The version comes from the Git tag. Creating a [new release](https://github.com/leplatrem/python-recettes/releases/) will build the package and publish it to PyPI.
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
CC0 1.0 Universal
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Buckwheat Crêpe Batter
|
|
3
|
+
preparation: 3min
|
|
4
|
+
portions: 8
|
|
5
|
+
tags: healthy, gluten-free
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
For Breton savoury crêpes (galettes).
|
|
9
|
+
|
|
10
|
+
# Preparation
|
|
11
|
+
|
|
12
|
+
Mix {{ 300g of buckwheat flour }}, {{ 10g of salt }}, {{ 1 egg }}, then gradually add {{ 750ml of water }}, keeping the batter smooth.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Caramel
|
|
3
|
+
cooking: 15min
|
|
4
|
+
tags: tips, dessert
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
How to get it right every time.
|
|
8
|
+
|
|
9
|
+
# Preparation
|
|
10
|
+
|
|
11
|
+
## Step 1
|
|
12
|
+
|
|
13
|
+
Pour a third of the {{ 150g of white sugar }} with {{ 1 tbsp of water }} into a heavy-bottomed saucepan and heat over *medium heat*.
|
|
14
|
+
|
|
15
|
+
## Step 2
|
|
16
|
+
|
|
17
|
+
As soon as it melts and turns liquid at the edges, add the second third. Then add the last third once the previous one has melted.
|
|
18
|
+
|
|
19
|
+
## Step 3
|
|
20
|
+
|
|
21
|
+
*Never stir*. Gently tilt the pan if needed to even it out.
|
|
22
|
+
|
|
23
|
+
## Step 4
|
|
24
|
+
|
|
25
|
+
Remove from the heat as soon as the caramel is golden (or gives off a light smoke).
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Crackers
|
|
3
|
+
portions: 20
|
|
4
|
+
preparation: 10
|
|
5
|
+
cooking: 1h
|
|
6
|
+
tags: snack, gluten-free
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Preparation
|
|
10
|
+
|
|
11
|
+
## Step 1
|
|
12
|
+
|
|
13
|
+
Mix {{ 30g of rolled oats }}, {{ 60g of pumpkin seeds }}, {{ 30g of sunflower seeds }}, {{ 130g of buckwheat flour }} and {{ 1/2 tsp of salt }}.
|
|
14
|
+
|
|
15
|
+
## Step 2
|
|
16
|
+
|
|
17
|
+
Stir {{ 130ml of water }} and {{ 20g of olive oil }} into the dry mix.
|
|
18
|
+
|
|
19
|
+
## Step 3
|
|
20
|
+
|
|
21
|
+
Add {{ 60g of grated cheese }}.
|
|
22
|
+
|
|
23
|
+
## Step 4
|
|
24
|
+
|
|
25
|
+
Lay down a first {{ sheet of baking paper }}. Spread the mixture on it, place a second sheet on top, and flatten with a rolling pin.
|
|
26
|
+
|
|
27
|
+
## Step 5
|
|
28
|
+
|
|
29
|
+
Score lines or triangles. Carefully remove the top sheet.
|
|
30
|
+
|
|
31
|
+
## Step 6
|
|
32
|
+
|
|
33
|
+
Bake at 150ºC for about 1 hour.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Crunchy Granola
|
|
3
|
+
preparation: 5min
|
|
4
|
+
cooking: 16min
|
|
5
|
+
tags: breakfast, healthy, gluten-free, budget-friendly
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A budget-friendly classic.
|
|
9
|
+
|
|
10
|
+
# Preparation
|
|
11
|
+
|
|
12
|
+
## Step 1
|
|
13
|
+
|
|
14
|
+
Mix {{ 3 mugs of rolled oats }}, {{ 4 tbsp of pure cocoa }}, {{ 3 tbsp of grated coconut }}, {{ 1 tbsp of sesame seeds }}, {{ 2 tbsp of flaked almonds }}.
|
|
15
|
+
|
|
16
|
+
## Step 2
|
|
17
|
+
|
|
18
|
+
Stir in {{ 1/2 mug of coconut oil }}, {{ 1/4 mug of rice syrup }}, {{ 1/4 mug of agave syrup }}, {{ 1 tbsp of vanilla extract }}.
|
|
19
|
+
|
|
20
|
+
## Step 3
|
|
21
|
+
|
|
22
|
+
Spread on {{ baking paper }} and bake at 180ºC for 10min.
|
|
23
|
+
|
|
24
|
+
## Step 4
|
|
25
|
+
|
|
26
|
+
Stir, and bake for another 6min.
|
|
27
|
+
|
|
28
|
+
## Step 5
|
|
29
|
+
|
|
30
|
+
Let cool and break into pieces.
|