texture-generator 0.3.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.
Files changed (51) hide show
  1. texture_generator-0.3.0/.python-version +1 -0
  2. texture_generator-0.3.0/CHANGELOG.md +124 -0
  3. texture_generator-0.3.0/LICENSE +201 -0
  4. texture_generator-0.3.0/MANIFEST.in +3 -0
  5. texture_generator-0.3.0/PKG-INFO +143 -0
  6. texture_generator-0.3.0/README.md +117 -0
  7. texture_generator-0.3.0/docs/reference.md +595 -0
  8. texture_generator-0.3.0/docs/releasing.md +107 -0
  9. texture_generator-0.3.0/pyproject.toml +82 -0
  10. texture_generator-0.3.0/setup.cfg +4 -0
  11. texture_generator-0.3.0/src/texture_generator.egg-info/PKG-INFO +143 -0
  12. texture_generator-0.3.0/src/texture_generator.egg-info/SOURCES.txt +49 -0
  13. texture_generator-0.3.0/src/texture_generator.egg-info/dependency_links.txt +1 -0
  14. texture_generator-0.3.0/src/texture_generator.egg-info/entry_points.txt +2 -0
  15. texture_generator-0.3.0/src/texture_generator.egg-info/requires.txt +3 -0
  16. texture_generator-0.3.0/src/texture_generator.egg-info/top_level.txt +1 -0
  17. texture_generator-0.3.0/src/texture_generators/__init__.py +223 -0
  18. texture_generator-0.3.0/src/texture_generators/__main__.py +6 -0
  19. texture_generator-0.3.0/src/texture_generators/cli.py +487 -0
  20. texture_generator-0.3.0/src/texture_generators/core/__init__.py +1 -0
  21. texture_generator-0.3.0/src/texture_generators/core/colour.py +108 -0
  22. texture_generator-0.3.0/src/texture_generators/core/fibres.py +603 -0
  23. texture_generator-0.3.0/src/texture_generators/core/fields.py +122 -0
  24. texture_generator-0.3.0/src/texture_generators/core/film.py +315 -0
  25. texture_generator-0.3.0/src/texture_generators/core/lic.py +371 -0
  26. texture_generator-0.3.0/src/texture_generators/core/noise.py +200 -0
  27. texture_generator-0.3.0/src/texture_generators/core/shading.py +488 -0
  28. texture_generator-0.3.0/src/texture_generators/core/spectral.py +227 -0
  29. texture_generator-0.3.0/src/texture_generators/core/warp.py +74 -0
  30. texture_generator-0.3.0/src/texture_generators/core/worley.py +91 -0
  31. texture_generator-0.3.0/src/texture_generators/materials/__init__.py +42 -0
  32. texture_generator-0.3.0/src/texture_generators/materials/metal.py +1368 -0
  33. texture_generator-0.3.0/src/texture_generators/materials/paper.py +1655 -0
  34. texture_generator-0.3.0/src/texture_generators/materials/plastic.py +272 -0
  35. texture_generator-0.3.0/src/texture_generators/materials/wood.py +2329 -0
  36. texture_generator-0.3.0/src/texture_generators/py.typed +0 -0
  37. texture_generator-0.3.0/src/texture_generators/samples.py +439 -0
  38. texture_generator-0.3.0/tests/test_cli_click.py +490 -0
  39. texture_generator-0.3.0/tests/test_generators.py +425 -0
  40. texture_generator-0.3.0/tests/test_lic.py +461 -0
  41. texture_generator-0.3.0/tests/test_metal_engine_turning.py +224 -0
  42. texture_generator-0.3.0/tests/test_metal_film.py +275 -0
  43. texture_generator-0.3.0/tests/test_metal_iridescence.py +240 -0
  44. texture_generator-0.3.0/tests/test_packaging.py +352 -0
  45. texture_generator-0.3.0/tests/test_paper_physics.py +809 -0
  46. texture_generator-0.3.0/tests/test_wood_anatomy.py +96 -0
  47. texture_generator-0.3.0/tests/test_wood_chatoyance.py +364 -0
  48. texture_generator-0.3.0/tests/test_wood_colour.py +275 -0
  49. texture_generator-0.3.0/tests/test_wood_rays.py +355 -0
  50. texture_generator-0.3.0/tests/test_wood_rings.py +313 -0
  51. texture_generator-0.3.0/uv.lock +923 -0
@@ -0,0 +1 @@
1
+ 3.14
@@ -0,0 +1,124 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [0.3.0] - 2026-09-08
11
+
12
+ ### Added
13
+
14
+ - Public package documentation, complete material parameter reference, and
15
+ GitHub Actions checks with Trusted Publishing.
16
+ - Source archive completeness and rebuild checks, plus clean installation
17
+ checks for both release artifacts.
18
+ - `resolve_variant(material, seed=None, variant=None)`: the concrete variant
19
+ `generate()` would render for those arguments. For a concrete seed it is the
20
+ variant `generate(material, seed=seed)` will render, so a caller can name a variant
21
+ before rendering it; with `seed=None` it just draws one, each call independent.
22
+
23
+ ### Changed
24
+
25
+ - The distribution is now named `texture-generator`; the `texture_generators`
26
+ import and `texture-gen` command remain available.
27
+ - Use Apache-2.0 licensing, setuptools and a literal version in `pyproject.toml`.
28
+ The public `__version__` reads installed distribution metadata.
29
+ - Use Ruff for formatting and keep development dependencies in `uv.lock`.
30
+ - Require Python 3.14 or later.
31
+
32
+ ### Fixed
33
+
34
+ - A `--size` below the generator's 2x2 minimum (`--size 1`, `16x0`, `-4`) is now
35
+ a usage error (exit 2) instead of a `ValueError` traceback.
36
+ - `--json` and the default filename now report the variant actually rendered
37
+ when `--variant` is omitted, rather than `null` — the report was unusable for
38
+ reproducing a render. Reproduce with the reported `seed`, leaving `--variant`
39
+ off: an omitted `--variant` is the seed's first draw, so passing the reported
40
+ variant back explicitly skips that draw and renders a different image. The
41
+ rendered bytes are unchanged by this reporting change.
42
+ - `sheet --json` reports the seed it drew instead of `null`, so a sheet rendered
43
+ without `--seed` can be reproduced by re-running with that `--seed`.
44
+ - An output path Pillow cannot write (no extension, unwritable directory) is now
45
+ a clean `Error: could not write …` and exit 1, not a traceback. Missing parent
46
+ directories are still created.
47
+ - `-o` together with `--outdir` is a usage error; `--outdir` used to be silently
48
+ ignored.
49
+ - `samples --help` documents its own `--outdir` default
50
+ (`$TEXTURE_GEN_SAMPLES_DIR`, else `/tmp/texture-gen-samples`); it was
51
+ inheriting the other commands' "the current directory", which it never uses.
52
+
53
+ ## [0.2.0] - 2026-09-07
54
+
55
+ ### Added
56
+
57
+ - `list` subcommand, printing every material and its variants (`--json` for the
58
+ machine-readable form) — the CLI can now be enumerated without reading the
59
+ source or the README.
60
+ - `--json` on every command, replacing the plain path lines with a report:
61
+ `{"written": [{"path", "material", "variant", "seed", "width", "height"}, …]}`
62
+ for the material commands and `all`, `"kind": "sheet"` for `sheet`,
63
+ `{"run_dir", "index", "count"}` for `samples`, and `{"materials": [...]}` for
64
+ `list`. `width`/`height` are the saved image's real pixel size.
65
+ - `-h` as a synonym for `--help`, `-V` for `--version`, and short forms
66
+ `-s`/`--size` and `-n`/`--count`.
67
+ - Per-command `--help` with the material's variants and a worked example, and
68
+ shell completion for bash, zsh and fish (`_TEXTURE_GEN_COMPLETE`), both free
69
+ from Click.
70
+
71
+ ### Changed
72
+
73
+ - **The CLI is now a command group built on Click** (a new `click>=8.1`
74
+ dependency) rather than a single argparse parser with a positional `TARGET`.
75
+ `texture-gen wood …`, `all`, `sheet` and `samples` are real subcommands, so
76
+ each carries only the options that apply to it and its own help. Every
77
+ command from 0.1.0 keeps working, but **options must now follow their
78
+ subcommand**: `texture-gen wood --size 16`, not `texture-gen --size 16 wood`,
79
+ which 0.1.0's single flat parser accepted. What else changes is that misuse is
80
+ now caught by the parser instead of by hand-written checks — `all -o x.png`,
81
+ `samples -o x.png` and `wood --only wood` are rejected as unknown options,
82
+ and `--count 0` by an integer range.
83
+ - `--variant` is validated per material against that material's own variants
84
+ (a `click.Choice`, so it is also completable). The material commands, their
85
+ variants and the choices are all derived from `MATERIALS` at import time, so
86
+ a new material or variant appears in the CLI and its help automatically.
87
+ - Usage-error text now comes from Click: an unknown variant reports
88
+ `Invalid value for '--variant': 'nope' is not one of 'board', 'planks'.`
89
+ rather than `choose from: …`. The exit status is still 2.
90
+ - Help output is capitalised `Usage:` (Click's convention) rather than
91
+ argparse's `usage:`, and `python -m texture_generators --help` still names the
92
+ program `texture-gen`.
93
+
94
+ ## [0.1.0] - 2026-09-06
95
+
96
+ ### Added
97
+
98
+ - Packaged as `texture-generators`: a src layout built with hatchling, so the
99
+ generator can be installed and imported rather than run from a checkout.
100
+ - `texture-gen` console script, exposing the same interface as
101
+ `python -m texture_generators`.
102
+ - `generate_array()`, returning the rendered texture as a float32 `(H, W, 3)`
103
+ numpy array in `[0, 1]` without the PIL conversion.
104
+ - `Material` protocol, documenting the contract every material module in
105
+ `MATERIALS` satisfies.
106
+ - `__version__` on the package.
107
+ - `samples.default_outdir()`, the rule the CLI uses when `--outdir` is omitted.
108
+ - `texture-gen --version`.
109
+ - `py.typed` marker, so type checkers use the package's own annotations.
110
+
111
+ ### Changed
112
+
113
+ - `samples` now chooses its default output directory by rule:
114
+ `$TEXTURE_GEN_SAMPLES_DIR` if set to a non-empty value, otherwise
115
+ `/tmp/texture-gen-samples` where
116
+ `/tmp` exists, otherwise the same directory under the system temp directory.
117
+ - Tests moved out of the package into a top-level `tests/` directory.
118
+ - Invalid material or variant names on the command line now produce a usage
119
+ error (exit status 2) instead of a traceback.
120
+
121
+ ### Removed
122
+
123
+ - Running from the checkout without installing: install the package (editable
124
+ for development) instead.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,3 @@
1
+ include CHANGELOG.md uv.lock .python-version
2
+ recursive-include docs *.md
3
+ recursive-include tests *.py
@@ -0,0 +1,143 @@
1
+ Metadata-Version: 2.4
2
+ Name: texture-generator
3
+ Version: 0.3.0
4
+ Summary: Procedural generator for random but realistic material textures (metal, plastic, wood, paper) as PNGs or numpy arrays
5
+ Author: Nick Powell
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/nmpowell/texture-generator
8
+ Project-URL: Issues, https://github.com/nmpowell/texture-generator/issues
9
+ Project-URL: Changelog, https://github.com/nmpowell/texture-generator/releases
10
+ Keywords: procedural,texture,noise,material,pbr,numpy
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.14
16
+ Classifier: Topic :: Multimedia :: Graphics
17
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
18
+ Classifier: Typing :: Typed
19
+ Requires-Python: >=3.14
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: click>=8.1
23
+ Requires-Dist: numpy>=2.0
24
+ Requires-Dist: pillow>=10.0
25
+ Dynamic: license-file
26
+
27
+ # texture-generator
28
+
29
+ Generate random material textures with Python: metal, plastic, wood and paper,
30
+ as Pillow images or NumPy arrays. Choose a size and seed to create a reproducible
31
+ texture, then save it as a PNG. Generation runs locally using NumPy and Pillow,
32
+ without models, downloaded assets or network access.
33
+
34
+ ## Installation
35
+
36
+ Requires Python 3.14 or later.
37
+
38
+ ```bash
39
+ pip install texture-generator
40
+ ```
41
+
42
+ The distribution is named `texture-generator`; the Python import is
43
+ `texture_generators`, and the command-line program is `texture-gen`.
44
+ Installation includes NumPy, Pillow and Click (used by the CLI).
45
+
46
+ ## Quickstart
47
+
48
+ ```python
49
+ from texture_generators import generate
50
+
51
+ image = generate("wood", size=(640, 480), seed=42, variant="board")
52
+ image.save("wood.png")
53
+ print(image.mode, image.size)
54
+ # RGB (640, 480)
55
+ ```
56
+
57
+ This writes `wood.png` in the current directory. Sizes are `(width, height)`;
58
+ an integer such as `size=512` creates a square. Both dimensions must be at least
59
+ 2 pixels. The same arguments reproduce the same image with the same package,
60
+ dependency versions and platform. Omit `seed` for a fresh texture.
61
+
62
+ For raw pixels or a labelled sheet of every variant:
63
+
64
+ ```python
65
+ from texture_generators import generate_array, sample_sheet
66
+
67
+ pixels = generate_array("metal", size=256, seed=7, variant="brushed")
68
+ print(pixels.shape, pixels.dtype)
69
+ # (256, 256, 3) float32
70
+
71
+ sheet = sample_sheet(size=128, seed=7)
72
+ sheet.save("materials.png")
73
+ ```
74
+
75
+ Arrays contain RGB values in `[0, 1]`. The
76
+ [API reference](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md#python-api)
77
+ covers all public functions and material parameters.
78
+
79
+ ## Command line
80
+
81
+ ```bash
82
+ texture-gen wood --variant board --size 640x480 --seed 42 -o wood.png
83
+ texture-gen list
84
+ texture-gen sheet --size 128 --seed 7 -o materials.png
85
+ texture-gen wood --help
86
+ ```
87
+
88
+ `python -m texture_generators` runs the same CLI. It also supports batches,
89
+ JSON reports, shell completion and browser galleries for comparing seeds and
90
+ parameters. See the
91
+ [CLI reference](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md#cli).
92
+
93
+ ## Materials
94
+
95
+ | Material | Variants |
96
+ | --- | --- |
97
+ | Metal | `brushed`, `radial`, `polished`, `heat_tinted`, `oil_film`, `anodised_titanium`, `engine_turned` |
98
+ | Plastic | `glossy`, `matte`, `textured` |
99
+ | Wood | `board`, `planks` |
100
+ | Paper | `white`, `kraft`, `recycled`, `newsprint`, `laid`, `coated` |
101
+
102
+ The generators combine noise, material anatomy and lighting. Albedo, height and
103
+ roughness share underlying fields so visible features also affect shading.
104
+ These are procedural approximations with documented calibration assumptions.
105
+ Metal, plastic and wood do not tile seamlessly; paper tiles when creases are
106
+ disabled with `creases=0.0`.
107
+
108
+ Read the
109
+ [technical reference](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md)
110
+ for the algorithms, wood and paper models, core modules, performance estimates
111
+ and limitations. See the
112
+ [changelog](https://github.com/nmpowell/texture-generator/blob/main/CHANGELOG.md)
113
+ for changes and
114
+ [GitHub issues](https://github.com/nmpowell/texture-generator/issues)
115
+ to report a bug.
116
+
117
+ ## Development
118
+
119
+ Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
120
+
121
+ ```bash
122
+ git clone https://github.com/nmpowell/texture-generator.git
123
+ cd texture-generator
124
+ uv sync --locked
125
+ uv run pytest
126
+ uv run ruff check .
127
+ uv run ruff format --check .
128
+ ```
129
+
130
+ `uv sync --locked` installs the project editable and uses the committed lockfile.
131
+ Use `uv run ruff format .` to apply formatting. The tests exercise rendering,
132
+ determinism, material physics, the CLI and built-package contents. Internal mypy
133
+ checks have existing findings and are informational; see the
134
+ [development notes](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md#development).
135
+
136
+ The version lives in `pyproject.toml`; `texture_generators.__version__` reads
137
+ the installed package metadata. The
138
+ [release guide](https://github.com/nmpowell/texture-generator/blob/main/docs/releasing.md)
139
+ covers artifact checks and Trusted Publishing.
140
+
141
+ ## License
142
+
143
+ [Apache License 2.0](https://github.com/nmpowell/texture-generator/blob/main/LICENSE).
@@ -0,0 +1,117 @@
1
+ # texture-generator
2
+
3
+ Generate random material textures with Python: metal, plastic, wood and paper,
4
+ as Pillow images or NumPy arrays. Choose a size and seed to create a reproducible
5
+ texture, then save it as a PNG. Generation runs locally using NumPy and Pillow,
6
+ without models, downloaded assets or network access.
7
+
8
+ ## Installation
9
+
10
+ Requires Python 3.14 or later.
11
+
12
+ ```bash
13
+ pip install texture-generator
14
+ ```
15
+
16
+ The distribution is named `texture-generator`; the Python import is
17
+ `texture_generators`, and the command-line program is `texture-gen`.
18
+ Installation includes NumPy, Pillow and Click (used by the CLI).
19
+
20
+ ## Quickstart
21
+
22
+ ```python
23
+ from texture_generators import generate
24
+
25
+ image = generate("wood", size=(640, 480), seed=42, variant="board")
26
+ image.save("wood.png")
27
+ print(image.mode, image.size)
28
+ # RGB (640, 480)
29
+ ```
30
+
31
+ This writes `wood.png` in the current directory. Sizes are `(width, height)`;
32
+ an integer such as `size=512` creates a square. Both dimensions must be at least
33
+ 2 pixels. The same arguments reproduce the same image with the same package,
34
+ dependency versions and platform. Omit `seed` for a fresh texture.
35
+
36
+ For raw pixels or a labelled sheet of every variant:
37
+
38
+ ```python
39
+ from texture_generators import generate_array, sample_sheet
40
+
41
+ pixels = generate_array("metal", size=256, seed=7, variant="brushed")
42
+ print(pixels.shape, pixels.dtype)
43
+ # (256, 256, 3) float32
44
+
45
+ sheet = sample_sheet(size=128, seed=7)
46
+ sheet.save("materials.png")
47
+ ```
48
+
49
+ Arrays contain RGB values in `[0, 1]`. The
50
+ [API reference](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md#python-api)
51
+ covers all public functions and material parameters.
52
+
53
+ ## Command line
54
+
55
+ ```bash
56
+ texture-gen wood --variant board --size 640x480 --seed 42 -o wood.png
57
+ texture-gen list
58
+ texture-gen sheet --size 128 --seed 7 -o materials.png
59
+ texture-gen wood --help
60
+ ```
61
+
62
+ `python -m texture_generators` runs the same CLI. It also supports batches,
63
+ JSON reports, shell completion and browser galleries for comparing seeds and
64
+ parameters. See the
65
+ [CLI reference](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md#cli).
66
+
67
+ ## Materials
68
+
69
+ | Material | Variants |
70
+ | --- | --- |
71
+ | Metal | `brushed`, `radial`, `polished`, `heat_tinted`, `oil_film`, `anodised_titanium`, `engine_turned` |
72
+ | Plastic | `glossy`, `matte`, `textured` |
73
+ | Wood | `board`, `planks` |
74
+ | Paper | `white`, `kraft`, `recycled`, `newsprint`, `laid`, `coated` |
75
+
76
+ The generators combine noise, material anatomy and lighting. Albedo, height and
77
+ roughness share underlying fields so visible features also affect shading.
78
+ These are procedural approximations with documented calibration assumptions.
79
+ Metal, plastic and wood do not tile seamlessly; paper tiles when creases are
80
+ disabled with `creases=0.0`.
81
+
82
+ Read the
83
+ [technical reference](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md)
84
+ for the algorithms, wood and paper models, core modules, performance estimates
85
+ and limitations. See the
86
+ [changelog](https://github.com/nmpowell/texture-generator/blob/main/CHANGELOG.md)
87
+ for changes and
88
+ [GitHub issues](https://github.com/nmpowell/texture-generator/issues)
89
+ to report a bug.
90
+
91
+ ## Development
92
+
93
+ Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
94
+
95
+ ```bash
96
+ git clone https://github.com/nmpowell/texture-generator.git
97
+ cd texture-generator
98
+ uv sync --locked
99
+ uv run pytest
100
+ uv run ruff check .
101
+ uv run ruff format --check .
102
+ ```
103
+
104
+ `uv sync --locked` installs the project editable and uses the committed lockfile.
105
+ Use `uv run ruff format .` to apply formatting. The tests exercise rendering,
106
+ determinism, material physics, the CLI and built-package contents. Internal mypy
107
+ checks have existing findings and are informational; see the
108
+ [development notes](https://github.com/nmpowell/texture-generator/blob/main/docs/reference.md#development).
109
+
110
+ The version lives in `pyproject.toml`; `texture_generators.__version__` reads
111
+ the installed package metadata. The
112
+ [release guide](https://github.com/nmpowell/texture-generator/blob/main/docs/releasing.md)
113
+ covers artifact checks and Trusted Publishing.
114
+
115
+ ## License
116
+
117
+ [Apache License 2.0](https://github.com/nmpowell/texture-generator/blob/main/LICENSE).