pyclay 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.
- pyclay-1.0.0/.gitignore +44 -0
- pyclay-1.0.0/CHANGELOG.md +24 -0
- pyclay-1.0.0/CONTRIBUTING.md +77 -0
- pyclay-1.0.0/LICENSE +203 -0
- pyclay-1.0.0/PKG-INFO +159 -0
- pyclay-1.0.0/README.md +125 -0
- pyclay-1.0.0/assets/favicon.ico +0 -0
- pyclay-1.0.0/pyclay/__init__.py +335 -0
- pyclay-1.0.0/pyclay/_cli.py +153 -0
- pyclay-1.0.0/pyclay/_renderer.py +1325 -0
- pyclay-1.0.0/pyclay/_runtime.py +70 -0
- pyclay-1.0.0/pyclay/_server.py +95 -0
- pyclay-1.0.0/pyproject.toml +63 -0
pyclay-1.0.0/.gitignore
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Byte-compiled / optimized
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.pyo
|
|
6
|
+
|
|
7
|
+
# Distribution / packaging
|
|
8
|
+
dist/
|
|
9
|
+
build/
|
|
10
|
+
*.egg-info/
|
|
11
|
+
*.egg
|
|
12
|
+
|
|
13
|
+
# Virtual environments
|
|
14
|
+
venv/
|
|
15
|
+
.venv/
|
|
16
|
+
env/
|
|
17
|
+
|
|
18
|
+
# IDE
|
|
19
|
+
.vscode/
|
|
20
|
+
.idea/
|
|
21
|
+
*.swp
|
|
22
|
+
*.swo
|
|
23
|
+
*~
|
|
24
|
+
|
|
25
|
+
# OS
|
|
26
|
+
.DS_Store
|
|
27
|
+
Thumbs.db
|
|
28
|
+
|
|
29
|
+
# Testing
|
|
30
|
+
.pytest_cache/
|
|
31
|
+
.coverage
|
|
32
|
+
htmlcov/
|
|
33
|
+
|
|
34
|
+
# Type checkers
|
|
35
|
+
.mypy_cache/
|
|
36
|
+
.pytype/
|
|
37
|
+
|
|
38
|
+
# Environment files
|
|
39
|
+
.env
|
|
40
|
+
*.env
|
|
41
|
+
|
|
42
|
+
# Editor files
|
|
43
|
+
*.sublime-project
|
|
44
|
+
*.sublime-workspace
|
|
@@ -0,0 +1,24 @@
|
|
|
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
|
+
## [0.3.0] - 2026-06-06
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- 4 built-in themes: Ivory, Nebula, Arctic, and Obsidian with live switching via navbar dropdown
|
|
12
|
+
- Hot reload dev server (`pyclay run`) with automatic browser refresh on file save
|
|
13
|
+
- Static HTML export (`pyclay build`) with hot-reload script auto-stripping
|
|
14
|
+
- Multi-page support with hash-based routing
|
|
15
|
+
- 20+ components: heading, text, card, table, metric, progress bar, accordion, tabs, alert, badge, button, link button, image, video, code block, blockquote, lists, and more
|
|
16
|
+
- Responsive column layout system that stacks on mobile (<768px)
|
|
17
|
+
- Syntax-highlighted code blocks via Prism.js (Python, Bash, JS, CSS)
|
|
18
|
+
- Navbar with hamburger menu on mobile
|
|
19
|
+
- Footer with simple and multi-column variants
|
|
20
|
+
- Custom styling support via `style` dict on every component
|
|
21
|
+
- `assets/` folder support for static files (images, videos, favicon)
|
|
22
|
+
- Auto-detection of `assets/favicon.ico`
|
|
23
|
+
- CLI with `run` and `build` commands
|
|
24
|
+
- Error overlay in dev mode with friendly traceback display
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Contributing to pyclay
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing! Here's how to get started.
|
|
4
|
+
|
|
5
|
+
## Development Setup
|
|
6
|
+
|
|
7
|
+
1. **Clone the repository:**
|
|
8
|
+
```bash
|
|
9
|
+
git clone https://github.com/ayush-sharma11/pyclay.git
|
|
10
|
+
cd pyclay
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
2. **Create a virtual environment:**
|
|
14
|
+
```bash
|
|
15
|
+
python -m venv venv
|
|
16
|
+
source venv/bin/activate # Linux/macOS
|
|
17
|
+
venv\Scripts\activate # Windows
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
3. **Install in development mode with dev dependencies:**
|
|
21
|
+
```bash
|
|
22
|
+
pip install -e ".[dev]"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
4. **Run the example app:**
|
|
26
|
+
```bash
|
|
27
|
+
pyclay run examples/app.py
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Running Tests
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pytest
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Project Structure
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
pyclay/
|
|
40
|
+
├── pyclay/ # The library package
|
|
41
|
+
│ ├── __init__.py # Public API (all pc.* functions)
|
|
42
|
+
│ ├── _cli.py # CLI entry point (run / build)
|
|
43
|
+
│ ├── _renderer.py # HTML generation engine
|
|
44
|
+
│ ├── _runtime.py # Component tree state management
|
|
45
|
+
│ └── _server.py # Dev server with hot reload
|
|
46
|
+
├── tests/ # Test suite
|
|
47
|
+
├── examples/ # Example apps
|
|
48
|
+
├── pyproject.toml # Package metadata & build config
|
|
49
|
+
└── CHANGELOG.md # Release history
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Making Changes
|
|
53
|
+
|
|
54
|
+
1. **Fork** the repository and create a new branch from `main`.
|
|
55
|
+
2. Make your changes and add tests if applicable.
|
|
56
|
+
3. Ensure all tests pass: `pytest`
|
|
57
|
+
4. **Commit** with a clear, descriptive message.
|
|
58
|
+
5. Open a **Pull Request** against `main`.
|
|
59
|
+
|
|
60
|
+
## Guidelines
|
|
61
|
+
|
|
62
|
+
- Keep the public API simple — every function should be intuitive for someone who's never written HTML.
|
|
63
|
+
- All public functions in `__init__.py` should have docstrings.
|
|
64
|
+
- Maintain backward compatibility where possible.
|
|
65
|
+
- If adding a new component, add a corresponding example in the demo app and a test.
|
|
66
|
+
|
|
67
|
+
## Reporting Bugs
|
|
68
|
+
|
|
69
|
+
Open an issue at [github.com/ayush-sharma11/pyclay/issues](https://github.com/ayush-sharma11/pyclay/issues) with:
|
|
70
|
+
- Python version
|
|
71
|
+
- OS
|
|
72
|
+
- Steps to reproduce
|
|
73
|
+
- Expected vs actual behavior
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
By contributing, you agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE).
|
pyclay-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
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
|
+
placeholder text, 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 2026 Ayush Sharma
|
|
190
|
+
https://ayushsharma.dev
|
|
191
|
+
https://github.com/ayush-sharma11
|
|
192
|
+
|
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
194
|
+
you may not use this file except in compliance with the License.
|
|
195
|
+
You may obtain a copy of the License at
|
|
196
|
+
|
|
197
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
|
+
|
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
202
|
+
See the License for the specific language governing permissions and
|
|
203
|
+
limitations under the License.
|
pyclay-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pyclay
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Build beautiful, responsive web pages entirely in Python. No HTML, CSS, or JS required.
|
|
5
|
+
Project-URL: Homepage, https://github.com/ayush-sharma11/pyclay
|
|
6
|
+
Project-URL: Repository, https://github.com/ayush-sharma11/pyclay
|
|
7
|
+
Project-URL: Documentation, https://github.com/ayush-sharma11/pyclay#readme
|
|
8
|
+
Project-URL: Issues, https://github.com/ayush-sharma11/pyclay/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/ayush-sharma11/pyclay/blob/main/CHANGELOG.md
|
|
10
|
+
Author: Ayush Sharma
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: framework,html,python,static-site,streamlit,ui,web
|
|
14
|
+
Classifier: Development Status :: 4 - Beta
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
24
|
+
Classifier: Topic :: Internet :: WWW/HTTP
|
|
25
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
26
|
+
Classifier: Topic :: Text Processing :: Markup :: HTML
|
|
27
|
+
Requires-Python: >=3.8
|
|
28
|
+
Requires-Dist: watchdog>=3.0
|
|
29
|
+
Provides-Extra: dev
|
|
30
|
+
Requires-Dist: build; extra == 'dev'
|
|
31
|
+
Requires-Dist: pytest>=7.0; extra == 'dev'
|
|
32
|
+
Requires-Dist: twine; extra == 'dev'
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
|
|
35
|
+
<p align="center">
|
|
36
|
+
<h1 align="center">pyclay</h1>
|
|
37
|
+
<p align="center"><strong>Build beautiful, responsive web pages entirely in Python.</strong></p>
|
|
38
|
+
<p align="center">No HTML. No CSS. No JavaScript. Just Python.</p>
|
|
39
|
+
</p>
|
|
40
|
+
|
|
41
|
+
<p align="center">
|
|
42
|
+
<a href="https://pypi.org/project/pyclay/"><img src="https://img.shields.io/pypi/v/pyclay?color=6366f1&style=flat-square" alt="PyPI"></a>
|
|
43
|
+
<a href="https://pypi.org/project/pyclay/"><img src="https://img.shields.io/pypi/pyversions/pyclay?color=818cf8&style=flat-square" alt="Python"></a>
|
|
44
|
+
<a href="LICENSE"><img src="https://img.shields.io/github/license/ayush-sharma11/pyclay?color=10b981&style=flat-square" alt="License"></a>
|
|
45
|
+
</p>
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
pyclay is a Python-native static site builder. Write Python functions, get a production-ready HTML page - with themes, responsive layouts, and zero frontend knowledge required.
|
|
50
|
+
|
|
51
|
+
Think of it as **Streamlit's simplicity, but for static sites you can deploy anywhere**.
|
|
52
|
+
|
|
53
|
+
## Features
|
|
54
|
+
|
|
55
|
+
- **4 Built-in Themes** - Ivory, Nebula, Arctic, and Obsidian. Switch live via dropdown.
|
|
56
|
+
- **Fully Responsive** - Columns stack on mobile, navbar collapses to hamburger.
|
|
57
|
+
- **Hot Reload** - Edit Python, save, browser refreshes instantly.
|
|
58
|
+
- **Static Export** - `pyclay build app.py` → one HTML file. Deploy anywhere.
|
|
59
|
+
- **Rich Components** - Cards, tables, metrics, accordions, tabs, alerts, code blocks with syntax highlighting, and more.
|
|
60
|
+
- **Zero Config** - No `package.json`, no `webpack`, no `node_modules`. Just `pip install` and go.
|
|
61
|
+
|
|
62
|
+
## Quick Start
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
pip install pyclay
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Create `app.py`:
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
import pyclay as pc
|
|
72
|
+
|
|
73
|
+
pc.page_config(title="My Site", theme="obsidian")
|
|
74
|
+
pc.navbar("My Site", links=[
|
|
75
|
+
{"text": "Home", "href": "#home"},
|
|
76
|
+
{"text": "About", "href": "#about"},
|
|
77
|
+
])
|
|
78
|
+
|
|
79
|
+
pc.page("Home")
|
|
80
|
+
pc.heading("Hello World!")
|
|
81
|
+
pc.text("Built with pyclay - no HTML required.")
|
|
82
|
+
|
|
83
|
+
pc.card(title="Why pyclay?",
|
|
84
|
+
body="Because life is too short to write HTML.")
|
|
85
|
+
|
|
86
|
+
pc.page("About")
|
|
87
|
+
pc.text("This is the about page.")
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Run the dev server:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
pyclay run app.py
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Build for production:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
pyclay build app.py
|
|
100
|
+
# → dist/index.html (deploy to GitHub Pages, Netlify, etc.)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Components
|
|
104
|
+
|
|
105
|
+
| Component | Usage |
|
|
106
|
+
|-----------|-------|
|
|
107
|
+
| **Typography** | `pc.heading()`, `pc.text()`, `pc.blockquote()` |
|
|
108
|
+
| **Layout** | `pc.columns()`, `pc.column()`, `pc.container()` |
|
|
109
|
+
| **Data** | `pc.table()`, `pc.metric()`, `pc.progress_bar()` |
|
|
110
|
+
| **UI** | `pc.card()`, `pc.button()`, `pc.link_button()`, `pc.badge()`, `pc.alert()` |
|
|
111
|
+
| **Interactive** | `pc.accordion()`, `pc.tabs()`, `pc.tab_panel()` |
|
|
112
|
+
| **Media** | `pc.image()`, `pc.video()`, `pc.code_block()`, `pc.link()` |
|
|
113
|
+
| **Navigation** | `pc.navbar()`, `pc.footer()`, `pc.page()` |
|
|
114
|
+
| **Utility** | `pc.spacer()`, `pc.divider()`, `pc.html_raw()` |
|
|
115
|
+
|
|
116
|
+
## Static Assets & Favicon
|
|
117
|
+
|
|
118
|
+
Place all your static files (images, videos, etc.) inside an `assets/` folder in your project root. You can reference them in your python code using relative paths like `assets/...`.
|
|
119
|
+
|
|
120
|
+
* **Favicon:** If you put `favicon.ico` in your `assets/` folder, `pyclay` will automatically detect and link it as your page favicon.
|
|
121
|
+
* **Dev Server:** The dev server (`pyclay run`) automatically serves static files requested from your `assets/` folder.
|
|
122
|
+
* **Static Export:** The build command (`pyclay build`) copies the entire `assets/` folder into your output directory (`dist/assets/`), keeping all media links fully working when deployed.
|
|
123
|
+
|
|
124
|
+
## Themes
|
|
125
|
+
|
|
126
|
+
```python
|
|
127
|
+
pc.page_config(theme="obsidian") # ivory | nebula | arctic | obsidian
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Users can switch themes live via the built-in dropdown in the navbar.
|
|
131
|
+
|
|
132
|
+
## Layout System
|
|
133
|
+
|
|
134
|
+
```python
|
|
135
|
+
with pc.columns([1, 2], gap="2rem"):
|
|
136
|
+
with pc.column():
|
|
137
|
+
pc.text("Narrow column")
|
|
138
|
+
with pc.column():
|
|
139
|
+
pc.text("Wide column")
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Columns automatically stack vertically on mobile (<768px).
|
|
143
|
+
|
|
144
|
+
## CLI Reference
|
|
145
|
+
|
|
146
|
+
| Command | Description |
|
|
147
|
+
|---------|-------------|
|
|
148
|
+
| `pyclay run <file.py>` | Start dev server with hot reload |
|
|
149
|
+
| `pyclay run <file.py> --port 3000` | Use a custom port |
|
|
150
|
+
| `pyclay build <file.py>` | Export static HTML to `dist/` |
|
|
151
|
+
| `pyclay build <file.py> --out public` | Custom output directory |
|
|
152
|
+
|
|
153
|
+
## Contributing
|
|
154
|
+
|
|
155
|
+
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
156
|
+
|
|
157
|
+
## License
|
|
158
|
+
|
|
159
|
+
Apache 2.0 - see [LICENSE](LICENSE).
|
pyclay-1.0.0/README.md
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<h1 align="center">pyclay</h1>
|
|
3
|
+
<p align="center"><strong>Build beautiful, responsive web pages entirely in Python.</strong></p>
|
|
4
|
+
<p align="center">No HTML. No CSS. No JavaScript. Just Python.</p>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://pypi.org/project/pyclay/"><img src="https://img.shields.io/pypi/v/pyclay?color=6366f1&style=flat-square" alt="PyPI"></a>
|
|
9
|
+
<a href="https://pypi.org/project/pyclay/"><img src="https://img.shields.io/pypi/pyversions/pyclay?color=818cf8&style=flat-square" alt="Python"></a>
|
|
10
|
+
<a href="LICENSE"><img src="https://img.shields.io/github/license/ayush-sharma11/pyclay?color=10b981&style=flat-square" alt="License"></a>
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
pyclay is a Python-native static site builder. Write Python functions, get a production-ready HTML page - with themes, responsive layouts, and zero frontend knowledge required.
|
|
16
|
+
|
|
17
|
+
Think of it as **Streamlit's simplicity, but for static sites you can deploy anywhere**.
|
|
18
|
+
|
|
19
|
+
## Features
|
|
20
|
+
|
|
21
|
+
- **4 Built-in Themes** - Ivory, Nebula, Arctic, and Obsidian. Switch live via dropdown.
|
|
22
|
+
- **Fully Responsive** - Columns stack on mobile, navbar collapses to hamburger.
|
|
23
|
+
- **Hot Reload** - Edit Python, save, browser refreshes instantly.
|
|
24
|
+
- **Static Export** - `pyclay build app.py` → one HTML file. Deploy anywhere.
|
|
25
|
+
- **Rich Components** - Cards, tables, metrics, accordions, tabs, alerts, code blocks with syntax highlighting, and more.
|
|
26
|
+
- **Zero Config** - No `package.json`, no `webpack`, no `node_modules`. Just `pip install` and go.
|
|
27
|
+
|
|
28
|
+
## Quick Start
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pip install pyclay
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Create `app.py`:
|
|
35
|
+
|
|
36
|
+
```python
|
|
37
|
+
import pyclay as pc
|
|
38
|
+
|
|
39
|
+
pc.page_config(title="My Site", theme="obsidian")
|
|
40
|
+
pc.navbar("My Site", links=[
|
|
41
|
+
{"text": "Home", "href": "#home"},
|
|
42
|
+
{"text": "About", "href": "#about"},
|
|
43
|
+
])
|
|
44
|
+
|
|
45
|
+
pc.page("Home")
|
|
46
|
+
pc.heading("Hello World!")
|
|
47
|
+
pc.text("Built with pyclay - no HTML required.")
|
|
48
|
+
|
|
49
|
+
pc.card(title="Why pyclay?",
|
|
50
|
+
body="Because life is too short to write HTML.")
|
|
51
|
+
|
|
52
|
+
pc.page("About")
|
|
53
|
+
pc.text("This is the about page.")
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Run the dev server:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
pyclay run app.py
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Build for production:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
pyclay build app.py
|
|
66
|
+
# → dist/index.html (deploy to GitHub Pages, Netlify, etc.)
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Components
|
|
70
|
+
|
|
71
|
+
| Component | Usage |
|
|
72
|
+
|-----------|-------|
|
|
73
|
+
| **Typography** | `pc.heading()`, `pc.text()`, `pc.blockquote()` |
|
|
74
|
+
| **Layout** | `pc.columns()`, `pc.column()`, `pc.container()` |
|
|
75
|
+
| **Data** | `pc.table()`, `pc.metric()`, `pc.progress_bar()` |
|
|
76
|
+
| **UI** | `pc.card()`, `pc.button()`, `pc.link_button()`, `pc.badge()`, `pc.alert()` |
|
|
77
|
+
| **Interactive** | `pc.accordion()`, `pc.tabs()`, `pc.tab_panel()` |
|
|
78
|
+
| **Media** | `pc.image()`, `pc.video()`, `pc.code_block()`, `pc.link()` |
|
|
79
|
+
| **Navigation** | `pc.navbar()`, `pc.footer()`, `pc.page()` |
|
|
80
|
+
| **Utility** | `pc.spacer()`, `pc.divider()`, `pc.html_raw()` |
|
|
81
|
+
|
|
82
|
+
## Static Assets & Favicon
|
|
83
|
+
|
|
84
|
+
Place all your static files (images, videos, etc.) inside an `assets/` folder in your project root. You can reference them in your python code using relative paths like `assets/...`.
|
|
85
|
+
|
|
86
|
+
* **Favicon:** If you put `favicon.ico` in your `assets/` folder, `pyclay` will automatically detect and link it as your page favicon.
|
|
87
|
+
* **Dev Server:** The dev server (`pyclay run`) automatically serves static files requested from your `assets/` folder.
|
|
88
|
+
* **Static Export:** The build command (`pyclay build`) copies the entire `assets/` folder into your output directory (`dist/assets/`), keeping all media links fully working when deployed.
|
|
89
|
+
|
|
90
|
+
## Themes
|
|
91
|
+
|
|
92
|
+
```python
|
|
93
|
+
pc.page_config(theme="obsidian") # ivory | nebula | arctic | obsidian
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Users can switch themes live via the built-in dropdown in the navbar.
|
|
97
|
+
|
|
98
|
+
## Layout System
|
|
99
|
+
|
|
100
|
+
```python
|
|
101
|
+
with pc.columns([1, 2], gap="2rem"):
|
|
102
|
+
with pc.column():
|
|
103
|
+
pc.text("Narrow column")
|
|
104
|
+
with pc.column():
|
|
105
|
+
pc.text("Wide column")
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Columns automatically stack vertically on mobile (<768px).
|
|
109
|
+
|
|
110
|
+
## CLI Reference
|
|
111
|
+
|
|
112
|
+
| Command | Description |
|
|
113
|
+
|---------|-------------|
|
|
114
|
+
| `pyclay run <file.py>` | Start dev server with hot reload |
|
|
115
|
+
| `pyclay run <file.py> --port 3000` | Use a custom port |
|
|
116
|
+
| `pyclay build <file.py>` | Export static HTML to `dist/` |
|
|
117
|
+
| `pyclay build <file.py> --out public` | Custom output directory |
|
|
118
|
+
|
|
119
|
+
## Contributing
|
|
120
|
+
|
|
121
|
+
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
122
|
+
|
|
123
|
+
## License
|
|
124
|
+
|
|
125
|
+
Apache 2.0 - see [LICENSE](LICENSE).
|
|
Binary file
|