Skip to content

cklenetsky/bgg_collection2html

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

100 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bgg_collection2html

Create html of your game lists on Board Game Geek

Description

This is a python script that will generate an HTML catalog for your board game collection.

Dependencies

  • bgg account
  • bgg XML API access token
  • python3 and requests library ** use pip install requests

Installing

  • git clone this directory :-)

Executing program

  • How to run the program
python generate_html.py --username USER --token BGG_API_TOKEN

Wait for the script to run. It will take a bit to download all of the information needed from BGG, but will write the results to output.html.

Help

  -h, --help            show this help message and exit
  -u USERNAME, --username USERNAME
                        User to pull BGG collection data from. (Required)
  -i, --index           Enables creating an index. (default=Off)
  --clean_all           Clear out Images, XML, and all other generated files. (default=Off)
  --clean_images        Clear out local images cache. (default=Off)
  --clean_xml           Clear out local xml cache. (default=Off)
  -o, --own             Enables pulling only games set to own on BGG. (default=Off)
  --minsleep MINSLEEP   Minimum sleep duration on XML error. (Default=10)
  --maxsleep MAXSLEEP   Maximum sleep duration on XML error. (Default=120)
  --no_cache            Turn off all caching (default=Off)
  --output OUTPUT       Output html file. (Default="./output.html")
  --images_path IMAGES_PATH
                        Images path. (Default="./Images")
  --xml_path XML_PATH   Game XML Path. (Default="./game_xml")
  --collection_xml COLLECTION_XML
                        Output collection XML file.(Default="./collection.xml")
  -t, --token           Application authorization token. (Required)

Authors

Contributors names and contact info

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

About

Generate an HTML catalog of your boardgamegeek.com collection.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 80.0%
  • CSS 17.1%
  • HTML 2.9%