Export GitHub Stars to LinkWarden
MIT License
StarWarden allows you to export GitHub stars to Linkwarden.
Clone the repository
Install requirements:
pip install -r requirements.txt
Create a .env
file with:
GITHUB_TOKEN=your_github_token
GITHUB_USERNAME=your_github_username
LINKWARDEN_URL=your_linkwarden_instance_url
LINKWARDEN_TOKEN=your_linkwarden_api_token
Run:
python starwarden.py
To directly update an existing collection without an interactive menu, run:
python starwarden.py -id YOUR_COLLECTION_ID
For automated, unsupervised updates, you can use Docker with the provided docker-compose.yml file.
Make sure you have Docker and Docker Compose installed on your system.
Create a .env
file in the project root with the following variables:
GITHUB_TOKEN=your_github_token
GITHUB_USERNAME=your_github_username
LINKWARDEN_URL=your_linkwarden_instance_url
LINKWARDEN_TOKEN=your_linkwarden_api_token
COLLECTION_ID=your_linkwarden_collection_id
CRON_SCHEDULE=0 0 * * * # Run daily at midnight, adjust as needed
Use the following docker-compose.yml
file:
version: "3"
services:
starwarden:
image: rtuszik/starwarden:latest
env_file: .env
volumes:
- ./starwarden.log:/app/starwarden.log
Run the following command to start the Docker container:
docker compose up -d
The container will now automatically run StarWarden on the specified schedule without any manual intervention.
To manually trigger an update, you can run:
docker compose exec starwarden python /app/starwarden.py -id $COLLECTION_ID
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.