Skip to main content

Create fresh, personal AI painted wallpapers

Project description

✨ AI Wallpaper

Get fresh, personal AI painted wallpapers daily

💎 Features

  • Get fresh, personal wallpapers painted for you by khoj ai
  • Automatically weaves your current city, moon phase, weather and (even recent experiences!) into the painting
  • Updates your Android or Mac wallpaper automatically
  • Schedule it to run every day and night
  • Customize the wallpapers by telling khoj what styles and information to use

✅ Prequisites

⚡️ Quickstart

pip install ai-wallpaper && KHOJ_API_KEY=<YOU_KHOJ_API_KEY> aiwall

🎁 Showcase

Day Night

https://github.com/debanjum/ai-wallpaper/assets/6413477/823c1624-6452-472e-8786-4cb79bcfa029

🪢 Customize

Minimal

 KHOJ_API_KEY=<YOUR_KHOJ_API_KEY> aiwall

Uze Custom Prompt

 KHOJ_API_KEY=<YOUR_KHOJ_API_KEY> aiwall "Generate a wallpaper based on the latest news here"

Use Custom Wallpaper Path

 KHOJ_API_KEY=<YOUR_KHOJ_API_KEY> WALLPAPER_PATH="~/Pictures/wallpaper.png" aiwall

Use Self-Hosted Khoj

 KHOJ_HOST="http://localhost:42100" aiwall

🚀 Upgrade

Automatically get a fresh and personal wallpaper painted for you every day and night

  • Create a simple shell script to call the AI wallpaper creation command
     echo "#!/bin/sh\nKHOJ_API_KEY=<YOUR_KHOJ_API_KEY> aiwall" > wallpaper.sh
     chmod +x wallpaper.sh
    
  • On Android: Use termux-job-scheduler on Termux to get yourself a fresh and personal wallpaper painted every 12 hours
     # Install termux-job-scheduler to trigger script at a regular interval
     pkg install termux-job-scheduler
     # Make Khoj paint you a new wallpaper every 12 hours
     termux-job-scheduler -s aiwall --period-ms 43200000 --persisted true
     # Optional, check that the script is active
     # termux-job-scheduler -p
    
    Note: You can use Tasker + Termux:Tasker or other automations apps to trigger the Wallpaper script as well
  • On Mac: Use Cron to get yourself a fresh and personal wallpaper painted every 12 hours
     # Open crontab in edit mode
     crontab -e
    
     # Add below snippet to your crontab
     # 0 */12 * * /path/to/ai/wallpaper/folder/wallpaper.sh
    
     # Optional, check that the script is active
     # crontab -l
    

Weave experiences from your notes into the Wallpapers

The AI wallpaper script can automatically incorporate any recent experiences from your notes into it's paintings. To use this you will need to sync your notes with Khoj.

🖥️ Develop

  1. Download and Install

     # Clone the repository
     git clone https://github.com/debajum/ai-wallpaper
    
     # Install dependencies
     cd ai-wallpaper && pip install .
    
  2. Edit application

  3. Run any of the following commands to paint using your updated application

    # Minimal
    KHOJ_API_KEY=<YOUR_KHOJ_API_KEY> python src/aiwall/paper.py
    
    # With Custom Prompt
    KHOJ_API_KEY=<YOUR_KHOJ_API_KEY> python src/aiwall/paper.py "Generate a wallpaper based on the latest news here"
    
    # With Custom Wallpaper File Path
    KHOJ_API_KEY=<YOUR_KHOJ_API_KEY> WALLPAPER_PATH="~/Pictures/wallpaper.png" python src/aiwall/paper.py
    
    # With Self-hosted Khoj
    KHOJ_HOST="http://localhost:42100" python src/aiwall/paper.py
    

🔖 LICENSE

This program is free software; it is distributed under the GNU General Public License v3.

GPLv3 © debanjum

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_wallpaper-0.1.dev19.tar.gz (20.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_wallpaper-0.1.dev19-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file ai_wallpaper-0.1.dev19.tar.gz.

File metadata

  • Download URL: ai_wallpaper-0.1.dev19.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for ai_wallpaper-0.1.dev19.tar.gz
Algorithm Hash digest
SHA256 0c068c825946eb711c05efb0ae6e46c2f1d9fb2037e938dc584f0ae67f0e1d85
MD5 d7d15620b1eb347987bc42f0a8d0f358
BLAKE2b-256 9bdb2e820d11930c56710bd5d5e5f5f878fd131eefa766d52234f60cca938b5f

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_wallpaper-0.1.dev19.tar.gz:

Publisher: pypi.yml on debanjum/ai-wallpaper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_wallpaper-0.1.dev19-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_wallpaper-0.1.dev19-py3-none-any.whl
Algorithm Hash digest
SHA256 48461df4ebeb2bc78d325804c344d16f00151a0874c9061334e5f1eb42fdf9e0
MD5 2b4348444533b1ac768f2ad2fb56f9fb
BLAKE2b-256 bea9c7b7bcdf689a6b9d574c8bcc0ece94c7b8511752fd82346cc6d1d4369031

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_wallpaper-0.1.dev19-py3-none-any.whl:

Publisher: pypi.yml on debanjum/ai-wallpaper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page