citry-ui 0.1.0__tar.gz

citry_ui-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## [0.1.0] - 2026-08-19
+
+### Added
+
+- Build application interfaces from 55 styled component families by registering `citry_ui` once with a Citry instance.
+- Use the same components in Citry templates or compose them from typed Python invocations.
+- Customize light and dark themes through documented CSS variables, parts, variants, sizes, slots, and attributes.
+- Render accessible server HTML, add keyboard and pointer interaction through
+  Citry's client runtime, and localize built-in labels through the bundled
+  catalog.
+
+[0.1.0]: https://github.com/citry-dev/citry/releases/tag/citry-ui%400.1.0

citry_ui-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 citry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

citry_ui-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include CHANGELOG.md

citry_ui-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: citry-ui
+Version: 0.1.0
+Summary: First-party styled component library for Citry
+Author-email: Juro Oravec <juraj.oravec.josefson@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://citry.dev
+Project-URL: Documentation, https://citry.dev/ui-library/
+Project-URL: Repository, https://github.com/citry-dev/citry
+Project-URL: Issues, https://github.com/citry-dev/citry/issues
+Project-URL: Changelog, https://github.com/citry-dev/citry/blob/main/packages/py/citry_ui/CHANGELOG.md
+Keywords: citry,components,frontend,ui
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+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: Programming Language :: Python :: 3.14
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_LICENSES.md
+Requires-Dist: citry<0.5.0,>=0.4.0
+Dynamic: license-file
+
+# Citry UI
+
+Citry UI is Citry's own styled component library.
+
+It gives you the building blocks for polished application interfaces without
+assembling a separate frontend component stack:
+
+- forms, navigation, dialogs, menus, feedback, layout, and data display;
+- accessible HTML with keyboard and pointer interactions;
+- useful server-rendered output before browser behavior starts;
+- consistent light and dark styling with theme variables and component parts;
+- built-in labels that applications can translate and override; and
+- Python composition alongside ordinary Citry template tags.
+
+Browse the [component catalog](https://citry.dev/ui-library/) for current
+guides and API references.
+
+## Alpha release
+
+Citry UI is in alpha.
+
+Components that already exist won't be removed (for example, `CButton` stays
+`CButton`), but component inputs may yet change before v1.0.
+
+## Installation
+
+Install it with Python 3.10 or newer. Needs `citry>=0.4`:
+
+```console
+python -m pip install citry-ui
+```
+
+## Usage
+
+Register components with `Citry.register_library()`:
+
+```python
+import citry_ui
+from citry import Citry, Component
+
+app = Citry()
+installed = app.register_library(citry_ui)
+
+class Page(Component):
+    citry = app
+    template = """
+      <main>
+        <c-CButton type="submit">
+          Save
+        </c-CButton>
+      </main>
+    """
+```
+
+You can also directly import the components:
+
+```python
+from citry_ui import CButton
+
+button = CButton(
+    loading=True,
+    class_=["toolbar-action", {"is-prominent": True}],
+    style={"inline-size": "100%"},
+    slots={"default": "Save"},
+)
+rendered = button.render(citry=app)
+```
+
+See [`docs/design/ui_components/button.md`](https://github.com/citry-dev/citry/blob/main/docs/design/ui_components/button.md).
+
+Note: Calling `str(button)` or `button.render()` without `citry=app` raises
+`LibraryComponentContextError`.
+
+## Locales
+
+To add selectable translations, named Citry UI format
+profiles, or browser-side locale switching, configure the catalog package that
+ships in this same wheel:
+
+```python
+app = Citry(
+    autodiscover=False,
+    extensions_defaults={
+        "i18n": {
+            "source_locale": "en-US",
+            "locales": ("en-US", "cs-CZ"),
+            "catalogs": ("citry_ui_i18n", "my_app_i18n"),
+        }
+    },
+)
+app.register_library(citry_ui)
+```
+
+Place an application catalog after `citry_ui_i18n` to override selected public
+keys. Components render their initial strings on the server. Under a
+client-enabled `<c-i18n>` provider, stable Citry UI text and attributes follow
+locale changes through `$c-tr`, while values created by component JavaScript
+use the same provider through `i18n.bind()`. Explicit component label inputs or
+slots always win for that instance and are not replaced after a locale switch.
+Each component reference ends with a structured **Translation keys** table.
+
+## Subclassing
+
+Advanced code can access or subclass the concrete class installed for this
+Citry instance:
+
+```python
+import citry_ui
+from citry import Citry, Component
+
+app = Citry()
+installed = app.register_library(citry_ui)
+...
+BoundButton = installed[CButton]
+```
+
+## Development
+
+Each family lives in one `citry_ui/components/c*/` directory. Its runtime module owns
+its schemas, behavior, template, and CSS. `components/__init__.py` contains the
+only ordered definition catalog, and the package root combines it with
+`ComponentLibrary`. Citry owns materialization, registration rollback,
+invocation resolution, and installation records.
+
+For editor completion and diagnostics without a host application, point the
+Citry VS Code setting directly at the same manifest:
+
+```json
+{
+  "citry.app": "citry_ui:__citry_library__"
+}
+```
+
+Contributors can read the
+[component-authoring guide](https://github.com/citry-dev/citry/blob/main/packages/py/citry_ui/docs/component-authoring.md)
+for the specification and source-formatting rules.
+
+## Early-access feedback
+
+Please report bugs, missing component states, accessibility problems, and API
+friction in the [Citry issue tracker](https://github.com/citry-dev/citry/issues).
+Include the component name, Citry UI version, browser, and a small reproduction
+when possible.

citry_ui-0.1.0/README.md

@@ -0,0 +1,143 @@
+# Citry UI
+
+Citry UI is Citry's own styled component library.
+
+It gives you the building blocks for polished application interfaces without
+assembling a separate frontend component stack:
+
+- forms, navigation, dialogs, menus, feedback, layout, and data display;
+- accessible HTML with keyboard and pointer interactions;
+- useful server-rendered output before browser behavior starts;
+- consistent light and dark styling with theme variables and component parts;
+- built-in labels that applications can translate and override; and
+- Python composition alongside ordinary Citry template tags.
+
+Browse the [component catalog](https://citry.dev/ui-library/) for current
+guides and API references.
+
+## Alpha release
+
+Citry UI is in alpha.
+
+Components that already exist won't be removed (for example, `CButton` stays
+`CButton`), but component inputs may yet change before v1.0.
+
+## Installation
+
+Install it with Python 3.10 or newer. Needs `citry>=0.4`:
+
+```console
+python -m pip install citry-ui
+```
+
+## Usage
+
+Register components with `Citry.register_library()`:
+
+```python
+import citry_ui
+from citry import Citry, Component
+
+app = Citry()
+installed = app.register_library(citry_ui)
+
+class Page(Component):
+    citry = app
+    template = """
+      <main>
+        <c-CButton type="submit">
+          Save
+        </c-CButton>
+      </main>
+    """
+```
+
+You can also directly import the components:
+
+```python
+from citry_ui import CButton
+
+button = CButton(
+    loading=True,
+    class_=["toolbar-action", {"is-prominent": True}],
+    style={"inline-size": "100%"},
+    slots={"default": "Save"},
+)
+rendered = button.render(citry=app)
+```
+
+See [`docs/design/ui_components/button.md`](https://github.com/citry-dev/citry/blob/main/docs/design/ui_components/button.md).
+
+Note: Calling `str(button)` or `button.render()` without `citry=app` raises
+`LibraryComponentContextError`.
+
+## Locales
+
+To add selectable translations, named Citry UI format
+profiles, or browser-side locale switching, configure the catalog package that
+ships in this same wheel:
+
+```python
+app = Citry(
+    autodiscover=False,
+    extensions_defaults={
+        "i18n": {
+            "source_locale": "en-US",
+            "locales": ("en-US", "cs-CZ"),
+            "catalogs": ("citry_ui_i18n", "my_app_i18n"),
+        }
+    },
+)
+app.register_library(citry_ui)
+```
+
+Place an application catalog after `citry_ui_i18n` to override selected public
+keys. Components render their initial strings on the server. Under a
+client-enabled `<c-i18n>` provider, stable Citry UI text and attributes follow
+locale changes through `$c-tr`, while values created by component JavaScript
+use the same provider through `i18n.bind()`. Explicit component label inputs or
+slots always win for that instance and are not replaced after a locale switch.
+Each component reference ends with a structured **Translation keys** table.
+
+## Subclassing
+
+Advanced code can access or subclass the concrete class installed for this
+Citry instance:
+
+```python
+import citry_ui
+from citry import Citry, Component
+
+app = Citry()
+installed = app.register_library(citry_ui)
+...
+BoundButton = installed[CButton]
+```
+
+## Development
+
+Each family lives in one `citry_ui/components/c*/` directory. Its runtime module owns
+its schemas, behavior, template, and CSS. `components/__init__.py` contains the
+only ordered definition catalog, and the package root combines it with
+`ComponentLibrary`. Citry owns materialization, registration rollback,
+invocation resolution, and installation records.
+
+For editor completion and diagnostics without a host application, point the
+Citry VS Code setting directly at the same manifest:
+
+```json
+{
+  "citry.app": "citry_ui:__citry_library__"
+}
+```
+
+Contributors can read the
+[component-authoring guide](https://github.com/citry-dev/citry/blob/main/packages/py/citry_ui/docs/component-authoring.md)
+for the specification and source-formatting rules.
+
+## Early-access feedback
+
+Please report bugs, missing component states, accessibility problems, and API
+friction in the [Citry issue tracker](https://github.com/citry-dev/citry/issues).
+Include the component name, Citry UI version, browser, and a small reproduction
+when possible.

citry_ui-0.1.0/THIRD_PARTY_LICENSES.md

@@ -0,0 +1,56 @@
+# Third-party licenses
+
+Citry UI vendors a selected, unmodified set of SVG icon geometries from
+Lucide 1.30.0. The source mapping and SHA-256 digest for every vendored SVG
+live in `citry_ui/components/cicon/_catalog.py`.
+
+## Lucide
+
+ISC License
+
+Copyright (c) 2026 Lucide Icons and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+## Feather-derived Lucide icons
+
+The following vendored icons are identified by Lucide as derived from Feather:
+`arrow-down`, `arrow-left`, `arrow-right`, `arrow-up`, `calendar`, `check`,
+`chevron-down`, `chevron-left`, `chevron-right`, `chevron-up`, `clock`,
+`circle-question-mark` (published as `circle-help`), `circle-x`, `download`,
+`external-link`, `info` (published by Citry UI as `circle-info`),
+`link`, `lock`, `minus`, `ellipsis` (published as `more-horizontal`),
+`ellipsis-vertical` (published as `more-vertical`), `plus`, `search`, `trash`,
+`triangle-alert` (legacy Lucide name `alert-triangle`), `upload`, and `x`.
+
+The MIT License (MIT)
+
+Copyright (c) 2013-present Cole Bemis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.