Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peggun/pyhtmlify
HTML in Pure Python.
https://github.com/peggun/pyhtmlify
Last synced: 5 days ago
JSON representation
HTML in Pure Python.
- Host: GitHub
- URL: https://github.com/peggun/pyhtmlify
- Owner: Peggun
- License: gpl-3.0
- Created: 2024-08-22T14:09:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-31T14:20:15.000Z (3 months ago)
- Last Synced: 2024-11-01T00:05:43.619Z (17 days ago)
- Language: Python
- Size: 58.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pyhtmlify
pyhtmlify is a Python package that allows you to write HTML code with Pure Python. This package was mainly made for the [osd Project](https://github.com/Peggun/osd) for simplicity. Heres how to use it. This package isn't completely finished, as we are still adding heaps of stuff and more HTML tags to this project.
Just quickly as well, currently you are unable to use the doctype and html tags as they are bugged and I do not know why. If you would like to add these tags, do so manually in the html file. If you would like to help fix this bug, please feel free too.
## 1. Installation
You can install pyhtml using pip
```py
pip install pyhtmlify
```
This will install the latest version of pyhtmlify.
## 2. How to use
pyhtmlify is quite easy to use. It is similar to html, but without all of the <> and other things involved. To do so, make a python file starting with html- and pyhtmlify will pick it up.
For pyhtmlify to pick up the file to generate the html code for you, you need to have a index function inside of your script. Like this for example:
```py
import pyhtmlify.HTMLTags.tags as ph
def index():
return ph.div(
ph.h1("Welcome to My Website"),
ph.input(type="text", placeholder="Enter your name"),
)
```
That is all you need for the script side. Now onto the html conversion
## 3. PY to HTML Conversion
To convert python index functions into html documents, pyhtmlify comes with a pyhtmlify command to use. In the terminal, to generate html code for all the html-*.py files, run
```py
pyhtmlify generate -f folder -i input_file -n file_name
```
The -f flag specifies the output folder, and there are some other flags and commands that are coming up.
However, you you dont use the -f flag, the program automatically defaults to /html.
The -i flag specifies the file you would like to generate html for. This defaults to the whole directory
The -n flag specifies the output files name. This defaults to the same name as the py file.
There is also a find command
```py
pyhtmlify find -f folder
```
This command finds all possible files to generate and tell you the file and the file path to it. If the -f flag isnt used, it will scan the entire working directory.
## 4. Contribution
If you would like to contribute to this project, please check out the issues and contact me at [email protected], or come check out osd and join the discord community!