pictlang 0.2.0__tar.gz

pictlang-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pictlang-0.2.0/PKG-INFO

@@ -0,0 +1,328 @@
+Metadata-Version: 2.4
+Name: pictlang
+Version: 0.2.0
+Summary: Generate SVG images from a theme and style via an LLM-written Python DSL
+Author: limloop
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/limloop/pictlang
+Project-URL: Repository, https://github.com/limloop/pictlang
+Project-URL: Issues, https://github.com/limloop/pictlang/issues
+Keywords: svg,llm,openai,image-generation,dsl,ai,pictlang
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0
+Requires-Dist: httpx>=0.25
+Requires-Dist: platformdirs>=4.0
+Provides-Extra: optimize
+Requires-Dist: scour>=0.38; extra == "optimize"
+Provides-Extra: socks
+Requires-Dist: httpx[socks]>=0.25; extra == "socks"
+Provides-Extra: all
+Requires-Dist: scour>=0.38; extra == "all"
+Requires-Dist: httpx[socks]>=0.25; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.8; extra == "dev"
+Dynamic: license-file
+
+# pictlang
+
+[![tests](https://github.com/limloop/pictlang/actions/workflows/tests.yml/badge.svg)](https://github.com/limloop/pictlang/actions/workflows/tests.yml)
+[![license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![python](https://img.shields.io/badge/python-3.10%2B-blue.svg)](pyproject.toml)
+[![pypi](https://img.shields.io/pypi/v/pictlang.svg)](https://pypi.org/project/pictlang/)
+[![pypi-downloads](https://img.shields.io/pypi/dm/pictlang.svg)](https://pypi.org/project/pictlang/)
+
+Generate SVG images from a theme and style via an LLM-written Python DSL.
+
+<table>
+<tr>
+<td align="center">
+<img src="examples/bauhaus-city/output.svg" width="200"><br>
+<sub>strict geometry, flat colors</sub>
+</td>
+<td align="center">
+<img src="examples/hud-interface/output.svg" width="200"><br>
+<sub>neon lines, glitch</sub>
+</td>
+<td align="center">
+<img src="examples/lighthouse-fog/output.svg" width="200"><br>
+<sub>minimalism, 3 colors</sub>
+</td>
+</tr>
+<tr>
+<td align="center">
+<img src="examples/underwater-jellyfish/output.svg" width="200"><br>
+<sub>soft gradients, opacity</sub>
+</td>
+<td align="center">
+<img src="examples/lineart-space/output.svg" width="200"><br>
+<sub>white outline on deep blue</sub>
+</td>
+<td></td>
+</tr>
+</table>
+
+<details>
+<summary>🇷🇺 Русский</summary>
+
+# pictlang
+
+Генерирует SVG-изображения по теме и стилю через Python-DSL,
+который пишет LLM.
+
+## Что это
+
+`pictlang` отправляет модели запрос с темой и стилем, получает
+Python-функцию `render()` и исполняет её в песочнице. Функция
+использует небольшой DSL для рисования, а не пишет SVG напрямую.
+Результат — валидный SVG-файл.
+
+Подход с DSL даёт три вещи:
+
+- **Экономия токенов.** Сцена на DSL в 15–30 раз короче, чем та же
+  сцена в чистом SVG. Циклы и функции сворачивают сотни
+  повторяющихся элементов в несколько строк.
+- **Валидация до исполнения.** Мы проверяем AST на «ровно один
+  `render()`, без импортов, без side effects» **до** запуска.
+- **Безопасность.** DSL — закрытый набор функций. Модель не может
+  выдать `<script>` или внешние ссылки.
+
+Подробности — в [`docs/architecture.md`](docs/architecture.md).
+
+## Установка
+
+```
+pip install pictlang
+```
+
+Опциональные зависимости:
+
+```
+pip install "pictlang[optimize]"   # scour для оптимизации SVG
+pip install "pictlang[socks]"      # поддержка SOCKS5-прокси
+pip install "pictlang[all]"        # всё сразу
+```
+
+## Быстрый старт
+
+Создайте конфиг и впишите свой API-ключ:
+
+```
+pictlang init --global
+# отредактируйте ~/.config/pictlang/config.json
+```
+
+Сгенерируйте картинку:
+
+```
+pictlang "lighthouse in the fog" --style "minimalism, three colors"
+```
+
+## Пример вывода
+
+```
+UUID: 550e8400-e29b-41d4-a716-446655440000
+SVG:  generated/valid/svg/550e8400-....svg
+PY:   generated/valid/py/550e8400-....py
+META: generated/valid/meta/550e8400-....json
+```
+
+UUID печатается в конце — по нему можно найти файлы позже.
+
+## CLI
+
+| Флаг | Что делает |
+|---|---|
+| `THEME` | Что рисовать (позиционный аргумент) |
+| `--style STYLE` | Как рисовать (обязателен) |
+| `--save valid\|all\|py\|svg` | Что сохранять (по умолчанию `valid`) |
+| `--optimize` / `--no-optimize` | Включить/выключить оптимизацию SVG |
+| `--optimizer auto\|scour\|svgo` | Какой оптимизатор использовать |
+| `--keep-original` | Сохранить SVG до оптимизации |
+| `--model NAME` | Переопределить модель |
+| `--base-url URL` | Переопределить endpoint |
+| `--proxy URL` | Прокси (http/https/socks5) |
+| `--config PATH` | Путь к конфигу |
+| `--check` | Проверить конфиг и соединение с API |
+
+Отдельные команды:
+
+| Команда | Что делает |
+|---|---|
+| `pictlang init [--global] [--path]` | Создать шаблон конфига |
+| `pictlang render [uuid] [--force]` | Перегенерировать SVG из `.py` без обращения к API |
+
+## Конфигурация
+
+`pictlang` читает конфиг из:
+
+1. `--config PATH`, если задан.
+2. `./pictlang.json` в текущей директории.
+3. Пользовательской директории:
+   - Linux: `~/.config/pictlang/config.json`
+   - macOS: `~/Library/Application Support/pictlang/config.json`
+   - Windows: `%APPDATA%\limloop\pictlang\config.json`
+4. Встроенных значений по умолчанию.
+
+Пример — в [`pictlang.json.example`](pictlang.json.example).
+
+## Документация
+
+- [`docs/dsl.md`](docs/dsl.md) — полный справочник по DSL.
+- [`docs/architecture.md`](docs/architecture.md) — как устроен pipeline.
+- [`docs/prompt.md`](docs/prompt.md) — как писать свои промпты.
+
+## Разработка
+
+```
+git clone https://github.com/limloop/pictlang.git
+cd pictlang
+pip install -e ".[dev]"
+pytest
+```
+
+## Лицензия
+
+Apache 2.0. См. [`LICENSE`](LICENSE).
+
+</details>
+
+---
+
+<details open>
+<summary>🇬🇧 English</summary>
+
+# pictlang
+
+Generate SVG images from a theme and style via an LLM-written Python DSL.
+
+## What it is
+
+`pictlang` sends a theme and a style to a model, receives a Python
+function `render()`, and runs it in a sandbox. The function uses a
+small drawing DSL instead of writing SVG directly. The result is a
+valid SVG file.
+
+The DSL approach gives three things:
+
+- **Token efficiency.** A scene in the DSL is 15–30× shorter than the
+  same scene in raw SVG. Loops and functions collapse hundreds of
+  repeated elements into a few lines.
+- **Validation before execution.** We check the AST for "exactly one
+  `render()`, no imports, no side effects" **before** running anything.
+- **Safety.** The DSL is a closed set of functions. The model cannot
+  emit `<script>` or external references.
+
+See [`docs/architecture.md`](docs/architecture.md) for details.
+
+## Install
+
+```
+pip install pictlang
+```
+
+Optional extras:
+
+```
+pip install "pictlang[optimize]"   # scour for SVG optimization
+pip install "pictlang[socks]"      # SOCKS5 proxy support
+pip install "pictlang[all]"        # everything
+```
+
+## Quick start
+
+Create a config and set your API key:
+
+```
+pictlang init --global
+# edit ~/.config/pictlang/config.json
+```
+
+Generate an image:
+
+```
+pictlang "lighthouse in the fog" --style "minimalism, three colors"
+```
+
+## Example output
+
+```
+UUID: 550e8400-e29b-41d4-a716-446655440000
+SVG:  generated/valid/svg/550e8400-....svg
+PY:   generated/valid/py/550e8400-....py
+META: generated/valid/meta/550e8400-....json
+```
+
+The UUID is printed at the end — use it to find the files later.
+
+## CLI
+
+| Flag | What it does |
+|---|---|
+| `THEME` | What to draw (positional) |
+| `--style STYLE` | How to draw it (required) |
+| `--save valid\|all\|py\|svg` | What to persist (default `valid`) |
+| `--optimize` / `--no-optimize` | Enable/disable SVG optimization |
+| `--optimizer auto\|scour\|svgo` | Which optimizer to use |
+| `--keep-original` | Save the SVG before optimization |
+| `--model NAME` | Override the model |
+| `--base-url URL` | Override the endpoint |
+| `--proxy URL` | Proxy (http/https/socks5) |
+| `--config PATH` | Path to a config file |
+| `--check` | Validate config and test API connectivity |
+
+Subcommands:
+
+| Command | What it does |
+|---|---|
+| `pictlang init [--global] [--path]` | Write a template config |
+| `pictlang render [uuid] [--force]` | Re-render `.svg` from `.py` without calling the API |
+
+## Configuration
+
+`pictlang` reads configuration from:
+
+1. `--config PATH`, if given.
+2. `./pictlang.json` in the current directory.
+3. The platform user-config directory:
+   - Linux: `~/.config/pictlang/config.json`
+   - macOS: `~/Library/Application Support/pictlang/config.json`
+   - Windows: `%APPDATA%\limloop\pictlang\config.json`
+4. Built-in defaults.
+
+See [`pictlang.json.example`](pictlang.json.example) for a template.
+
+## Documentation
+
+- [`docs/dsl.md`](docs/dsl.md) — full DSL reference.
+- [`docs/architecture.md`](docs/architecture.md) — how the pipeline works.
+- [`docs/prompt.md`](docs/prompt.md) — how to write custom prompts.
+
+## Development
+
+```
+git clone https://github.com/limloop/pictlang.git
+cd pictlang
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+Apache 2.0. See [`LICENSE`](LICENSE).
+
+</details>