A comprehensive Python package for seamless integration of CSS frameworks (Tailwind CSS, Bootstrap) with ReactPy applications and HTML projects
Project description
ReactFlow CSS
ReactFlow CSS is a Python package that simplifies the integration of popular CSS frameworks like Tailwind CSS and Bootstrap into your ReactPy applications and other HTML projects. It provides a streamlined API for configuring, compiling, and serving CSS, making it easier to manage your styles directly from Python.
Features
- Tailwind CSS Integration: Configure and compile Tailwind CSS seamlessly within your Python projects.
- Bootstrap Integration: Include Bootstrap CSS and JavaScript with minimal setup.
- Google SVG Icons: Access and generate SVG icons from Google Material Icons directly in your projects.
- ReactPy Compatibility: Specifically designed for ReactPy components and workflows.
- Unified API:
Helperclass for managing multiple frameworks through a single interface. - Template Management: Built-in templates and default styles for rapid development.
Installation
Install ReactFlow CSS using pip:
pip install ReactFlow-CSS
Quick Start
Basic Configuration
First, create a configuration for your preferred CSS framework:
# For Tailwind CSS
from reactflow_css.tailwindcss import configure_tailwind
config_tailwind = configure_tailwind(__file__)
# For Bootstrap
from reactflow_css.bootstrap import configure_boots
config_boots = configure_boots(__file__)
Getting Default Templates
Generate default CSS templates quickly:
# Get default Tailwind CSS template
from reactflow_css.tailwindcss import default_tailwind
tailwind_css = default_tailwind(path_output="./styles/tailwind.css")
# Get default Bootstrap template
from reactflow_css.bootstrap import default_boots
bootstrap_css = default_boots(path_output="./styles/bootstrap.css")
Parameters:
path_output(str, optional): File path to save the generated CSS content. IfNone, return content as string only.
Tailwind CSS Integration
Step 1: Configure Tailwind
Set up your Tailwind configuration:
from reactflow_css.tailwindcss import configure_tailwind
config_tailwind = configure_tailwind(__file__)
# Define Tailwind configuration
tailwind_config = {
"content": ["./src/**/*.{js,ts,jsx,tsx,py}", "./templates/**/*.html"],
"theme": {
"extend": {
"colors": {
"primary": "#3b82f6",
"secondary": "#64748b"
}
}
},
"plugins": []
}
# Apply configuration
config_tailwind.config(tailwind_config)
Step 2: Set Up Templates
Generate the necessary Tailwind files:
# Create tailwind.config.js and input.css files
config_tailwind.render_templates(
path_config="./tailwind.config.js",
path_index="./input.css"
)
# Or use default templates
config_tailwind.default_templates(path_output="./styles/")
Step 3: Compile CSS
Compile your Tailwind CSS:
# Compile with file paths
compiled_css = config_tailwind.compile(
path_config="./tailwind.config.js",
path_index="./input.css",
path_output="./dist/styles.css"
)
# Or compile with inline styles
compiled_css = config_tailwind.compile(
index="@tailwind base; @tailwind components; @tailwind utilities;",
path_output="./dist/styles.css"
)
Bootstrap Integration
Step 1: Set Up Templates
Initialize Bootstrap templates:
from reactflow_css.bootstrap import configure_boots
config_boots = configure_boots(__file__)
# Render template from existing file
template_content = config_boots.render_templates(path_index="./styles/custom.css")
Step 2: Configure Styles
Add custom styles and imports:
# Configure with custom styles and imports
custom_css = """
.custom-button {
background-color: #007bff;
border: none;
padding: 12px 24px;
border-radius: 4px;
}
"""
bootstrap_css = config_boots.config(
style=custom_css,
path_output="./dist/bootstrap-custom.css",
'@import "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css";',
'@import "./additional-styles.css";',
'@import "--/css/bootstrap.min.css";'
)
If you use this format @import '--/...' then it will import the css module from the main folder of this package.
Google Icons Integration
Generate SVG icons from Google Material Icons:
from reactflow_css.icons import generate_icons
# Generate single icon
icon_svg = generate_icons("home")
print(icon_svg)
# Generate multiple icons
icons = generate_icons("home", "settings", "account_circle")
for name, svg in icons.items():
with open(f"./icons/{name}.svg", "w") as f:
f.write(svg)
API Reference
See the source documentation for complete API reference for each module:
reactflow_css.tailwindcssreactflow_css.bootstrapreactflow_css.icons
License
This project is licensed under the MIT License. See the LICENSE file for details. The included Google icons are licensed under the Apache 2.0 License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reactflow_css-2.0.0a8.tar.gz.
File metadata
- Download URL: reactflow_css-2.0.0a8.tar.gz
- Upload date:
- Size: 3.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
20ea146a8ee07816cc5137921d6cc461d23e2c4fef3ece51d1de926d1610eee5
|
|
| MD5 |
77216669e34d2c38fc155889ac5ed05f
|
|
| BLAKE2b-256 |
cf4a26068394805c19188353c33936dd2c72aea6b52ef473e488637a845ca84d
|
File details
Details for the file reactflow_css-2.0.0a8-py3-none-any.whl.
File metadata
- Download URL: reactflow_css-2.0.0a8-py3-none-any.whl
- Upload date:
- Size: 6.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e78046d09f0d70072cf13c34399ccde29b0f3e060dc72cfcaf24f7f72d29a3f1
|
|
| MD5 |
f8c84084bc53369f4199d6e4d9b99aa2
|
|
| BLAKE2b-256 |
aadad79acd3c7a698dcc6b9832078fa218163941c3d8fb23405dc5e37645c1d0
|