Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,241 +1,34 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# π± QR Code Generator
|
| 2 |
|
| 3 |
**Free & Open Source** β’ **No Ads** β’ **Privacy-Friendly**
|
| 4 |
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-

|
| 8 |
-
|
| 9 |
-
---
|
| 10 |
|
| 11 |
## β¨ Features
|
| 12 |
|
| 13 |
-
|
| 14 |
-
- **
|
| 15 |
-
- **
|
| 16 |
-
- **
|
| 17 |
-
- **
|
| 18 |
-
- **Text** - Any plain text message
|
| 19 |
-
|
| 20 |
-
### π¨ **Customization Options**
|
| 21 |
-
- **Colors** - Custom foreground and background colors
|
| 22 |
-
- **Shapes** - Square, Rounded, Circle, Gapped Square modules
|
| 23 |
-
- **Resolution** - Adjustable size (5-30 pixels per module)
|
| 24 |
-
- **Error Correction** - 4 levels (Low, Medium, High, Very High)
|
| 25 |
-
- **Logo Integration** - Add your logo to the center of QR codes
|
| 26 |
-
|
| 27 |
-
### π‘οΈ **Privacy First**
|
| 28 |
-
- β
No data collection
|
| 29 |
-
- β
No tracking or analytics
|
| 30 |
-
- β
Everything runs in your browser
|
| 31 |
-
- β
No registration required
|
| 32 |
-
- β
Open source code
|
| 33 |
-
|
| 34 |
-
---
|
| 35 |
-
|
| 36 |
-
## π Live Demo
|
| 37 |
-
|
| 38 |
-
**Try it now:** [streamlit-qrcode.streamlit.app](https://streamlit-qrcode.streamlit.app) *(update with your actual URL)*
|
| 39 |
-
|
| 40 |
-
---
|
| 41 |
-
|
| 42 |
-
## π» Run Locally
|
| 43 |
-
|
| 44 |
-
### Prerequisites
|
| 45 |
-
- Python 3.7 or higher
|
| 46 |
-
- pip package manager
|
| 47 |
-
|
| 48 |
-
### Installation
|
| 49 |
-
|
| 50 |
-
```bash
|
| 51 |
-
# Clone the repository
|
| 52 |
-
git clone https://github.com/kaiser-data/streamlit-qrcode.git
|
| 53 |
-
cd streamlit-qrcode
|
| 54 |
-
|
| 55 |
-
# Install dependencies
|
| 56 |
-
pip install -r requirements.txt
|
| 57 |
-
|
| 58 |
-
# Run the app
|
| 59 |
-
streamlit run qr_generator.py
|
| 60 |
-
```
|
| 61 |
-
|
| 62 |
-
The app will open in your browser at `http://localhost:8501`
|
| 63 |
-
|
| 64 |
-
---
|
| 65 |
-
|
| 66 |
-
## π― Use Cases
|
| 67 |
-
|
| 68 |
-
| Use Case | Example | Description |
|
| 69 |
-
|----------|---------|-------------|
|
| 70 |
-
| **Marketing** | Product pages, promotions | Link to campaigns and track engagement |
|
| 71 |
-
| **Events** | Tickets, schedules | Easy access to event information |
|
| 72 |
-
| **WiFi Sharing** | Guest network access | Share WiFi without typing passwords |
|
| 73 |
-
| **Business Cards** | vCard, LinkedIn | Digital contact information |
|
| 74 |
-
| **Restaurants** | Menus, ordering | Contactless menu access |
|
| 75 |
-
| **Education** | Resources, assignments | Quick access to learning materials |
|
| 76 |
-
|
| 77 |
-
---
|
| 78 |
-
|
| 79 |
-
## π How to Use
|
| 80 |
-
|
| 81 |
-
### Basic Usage
|
| 82 |
-
1. **Choose a template** or enter content directly
|
| 83 |
-
2. **(Optional)** Customize colors, shapes, and size
|
| 84 |
-
3. **Download** your QR code as PNG
|
| 85 |
-
|
| 86 |
-
### WiFi QR Codes
|
| 87 |
-
1. Click the **WiFi** template
|
| 88 |
-
2. Enter your network name and password
|
| 89 |
-
3. Select security type (WPA/WEP/None)
|
| 90 |
-
4. Download and share!
|
| 91 |
-
|
| 92 |
-
### Adding Logos
|
| 93 |
-
1. Expand **"Customize Appearance"**
|
| 94 |
-
2. Go to **Logo** tab
|
| 95 |
-
3. Upload your logo (PNG recommended)
|
| 96 |
-
4. Adjust logo size (keep under 30% for best scanning)
|
| 97 |
-
5. Use **High** or **Very High** error correction
|
| 98 |
-
|
| 99 |
-
---
|
| 100 |
-
|
| 101 |
-
## π οΈ Technical Details
|
| 102 |
-
|
| 103 |
-
### Built With
|
| 104 |
-
- **[Streamlit](https://streamlit.io)** - Web framework
|
| 105 |
-
- **[python-qrcode](https://github.com/lincolnloop/python-qrcode)** - QR code generation
|
| 106 |
-
- **[Pillow](https://python-pillow.org/)** - Image processing
|
| 107 |
-
|
| 108 |
-
### Features
|
| 109 |
-
- **Error Correction Levels**: L (7%), M (15%), Q (25%), H (30%)
|
| 110 |
-
- **Module Shapes**: Square, Rounded, Circle, Gapped Square
|
| 111 |
-
- **Output Format**: PNG with adjustable resolution
|
| 112 |
-
- **Logo Support**: Centered logo with automatic sizing
|
| 113 |
-
|
| 114 |
-
### Supported QR Code Types
|
| 115 |
-
- URLs and websites
|
| 116 |
-
- WiFi credentials (WPA/WEP/Open)
|
| 117 |
-
- Email addresses (mailto links)
|
| 118 |
-
- Phone numbers (tel links)
|
| 119 |
-
- SMS messages
|
| 120 |
-
- Plain text
|
| 121 |
-
- Any custom formatted string
|
| 122 |
-
|
| 123 |
-
---
|
| 124 |
-
|
| 125 |
-
## π¦ Deployment
|
| 126 |
-
|
| 127 |
-
### Streamlit Cloud (Free)
|
| 128 |
-
|
| 129 |
-
1. **Fork this repository** or push to your GitHub account
|
| 130 |
-
|
| 131 |
-
2. **Deploy to Streamlit Cloud:**
|
| 132 |
-
- Go to [share.streamlit.io](https://share.streamlit.io)
|
| 133 |
-
- Click "New app"
|
| 134 |
-
- Select your repository: `kaiser-data/streamlit-qrcode`
|
| 135 |
-
- Main file: `qr_generator.py`
|
| 136 |
-
- Click "Deploy"
|
| 137 |
-
|
| 138 |
-
3. **Your app will be live** at a free Streamlit URL in ~2 minutes!
|
| 139 |
-
|
| 140 |
-
### Other Platforms
|
| 141 |
-
- **Heroku**: Add `setup.sh` and `Procfile`
|
| 142 |
-
- **Docker**: Build from included `Dockerfile`
|
| 143 |
-
- **VPS**: Run with `streamlit run qr_generator.py --server.port 80`
|
| 144 |
-
|
| 145 |
-
---
|
| 146 |
-
|
| 147 |
-
## π‘ Best Practices
|
| 148 |
-
|
| 149 |
-
### For Optimal Scanning
|
| 150 |
-
- β
Keep content short (use URL shorteners for long links)
|
| 151 |
-
- β
Use high contrast (dark on light background)
|
| 152 |
-
- β
Minimum print size: 2Γ2 cm (0.8Γ0.8 inches)
|
| 153 |
-
- β
Test QR codes before mass printing
|
| 154 |
-
- β
Use higher error correction when adding logos
|
| 155 |
-
|
| 156 |
-
### For Logo Integration
|
| 157 |
-
- β
Use transparent PNG images
|
| 158 |
-
- β
Keep logo size under 30% of QR code
|
| 159 |
-
- β
Use "High" or "Very High" error correction
|
| 160 |
-
- β
Test scannability after adding logo
|
| 161 |
-
- β
Ensure logo doesn't obscure critical areas
|
| 162 |
-
|
| 163 |
-
---
|
| 164 |
-
|
| 165 |
-
## π€ Contributing
|
| 166 |
-
|
| 167 |
-
Contributions are welcome! Here's how you can help:
|
| 168 |
-
|
| 169 |
-
1. **Fork the repository**
|
| 170 |
-
2. **Create a feature branch** (`git checkout -b feature/AmazingFeature`)
|
| 171 |
-
3. **Commit your changes** (`git commit -m 'Add some AmazingFeature'`)
|
| 172 |
-
4. **Push to the branch** (`git push origin feature/AmazingFeature`)
|
| 173 |
-
5. **Open a Pull Request**
|
| 174 |
-
|
| 175 |
-
### Ideas for Contributions
|
| 176 |
-
- [ ] Additional QR code styles
|
| 177 |
-
- [ ] Batch QR code generation
|
| 178 |
-
- [ ] SVG export option
|
| 179 |
-
- [ ] QR code analytics
|
| 180 |
-
- [ ] More customization options
|
| 181 |
-
- [ ] Internationalization (i18n)
|
| 182 |
-
|
| 183 |
-
---
|
| 184 |
-
|
| 185 |
-
## π License
|
| 186 |
-
|
| 187 |
-
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
|
| 188 |
-
|
| 189 |
-
### What this means:
|
| 190 |
-
- β
Free to use for personal and commercial projects
|
| 191 |
-
- β
Modify and distribute as you like
|
| 192 |
-
- β
No warranty or liability
|
| 193 |
-
- β
Must include original license and copyright
|
| 194 |
-
|
| 195 |
-
---
|
| 196 |
-
|
| 197 |
-
## π Acknowledgments
|
| 198 |
-
|
| 199 |
-
- **QR Code Technology**: Invented by Denso Wave (1994)
|
| 200 |
-
- **Streamlit Team**: For the amazing framework
|
| 201 |
-
- **python-qrcode**: For the robust QR generation library
|
| 202 |
-
- **Community**: For feedback and contributions
|
| 203 |
-
|
| 204 |
-
---
|
| 205 |
-
|
| 206 |
-
## π Support
|
| 207 |
-
|
| 208 |
-
- **Issues**: [GitHub Issues](https://github.com/kaiser-data/streamlit-qrcode/issues)
|
| 209 |
-
- **Discussions**: [GitHub Discussions](https://github.com/kaiser-data/streamlit-qrcode/discussions)
|
| 210 |
-
- **Star this repo** if you find it useful! β
|
| 211 |
-
|
| 212 |
-
---
|
| 213 |
-
|
| 214 |
-
## π Privacy & Security
|
| 215 |
-
|
| 216 |
-
This app is designed with privacy in mind:
|
| 217 |
-
|
| 218 |
-
- **No data storage**: QR codes are generated in your browser and not stored
|
| 219 |
-
- **No tracking**: No analytics or tracking cookies
|
| 220 |
-
- **No server-side processing**: All processing happens client-side
|
| 221 |
-
- **Open source**: Full code transparency - see exactly what it does
|
| 222 |
-
- **No third-party services**: No external API calls or data sharing
|
| 223 |
-
|
| 224 |
-
---
|
| 225 |
-
|
| 226 |
-
## π Project Stats
|
| 227 |
-
|
| 228 |
-

|
| 229 |
-

|
| 230 |
-

|
| 231 |
-

|
| 232 |
-
|
| 233 |
-
---
|
| 234 |
|
| 235 |
-
|
| 236 |
|
| 237 |
-
|
|
|
|
|
|
|
| 238 |
|
| 239 |
-
|
| 240 |
|
| 241 |
-
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: QR Code Generator
|
| 3 |
+
emoji: π±
|
| 4 |
+
colorFrom: green
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_file: qr_generator.py
|
| 8 |
+
pinned: false
|
| 9 |
+
license: mit
|
| 10 |
+
---
|
| 11 |
# π± QR Code Generator
|
| 12 |
|
| 13 |
**Free & Open Source** β’ **No Ads** β’ **Privacy-Friendly**
|
| 14 |
|
| 15 |
+
Create custom QR codes with various styles, colors, and logos - all in your browser, completely free!
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
## β¨ Features
|
| 18 |
|
| 19 |
+
- π **Quick Start Templates** - URL, WiFi, Email, Phone, Text
|
| 20 |
+
- π¨ **Full Customization** - Colors, shapes, sizes, error correction
|
| 21 |
+
- πΌοΈ **Logo Integration** - Add your logo to QR codes
|
| 22 |
+
- π‘οΈ **Privacy First** - No tracking, no data collection
|
| 23 |
+
- β¬οΈ **Instant Download** - PNG format, ready to use
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 24 |
|
| 25 |
+
## π How to Use
|
| 26 |
|
| 27 |
+
1. Choose a template or enter your content
|
| 28 |
+
2. (Optional) Customize appearance
|
| 29 |
+
3. Download your QR code!
|
| 30 |
|
| 31 |
+
## π¦ Repository
|
| 32 |
|
| 33 |
+
View the full source code and documentation:
|
| 34 |
+
π [GitHub Repository](https://github.com/kaiser-data/streamlit-qrcode)
|