abrax edited this page 4 years ago



  1. Make sure you have Python 3
  2. Download the most recent .whl package from under dist/
  3. Install with pip: pip3 install lizard-0.<VERSION HERE>-py3-none-any.whl

This will also upgrade to a newer version if you have an older version installed.

To uninstall, you can do pip uninstall lizard.

Other OSes

Python is supposed to be cross platform, so you should be able to pip install it anywhere. However I have no idea how it will behave outside Linux, since I haven’t had a chance to try it. I also don’t know where the lizard_data directory will end up - I use the home folder which is well-defined on Linux but on other OSes it is sometimes complicated where that is.


If you’ve been using Lizard for a while and are upgrading to a new release, be very careful with your local data. When a new version changes the database code or how local files are stored, it could fail to read your old shit and even corrupt it. I try to note this somewhere when it happens, but I may forget or you may not see the announcement. If in doubt, backup everything (all of Lizard’s data is stored under ~/lizard_data/) before trying the new version.

If you know for sure that a version breaks backwards compatibility, you have the following options:

  • Just say fuck it and start over with fresh database.
  • Run lizard e in your old lizard, save the resulting file, install the new version and then re-construct your watch list by running the exported commands. If you had any unseen replies or something you might lose those, so I’d check first with lizard r and lizard l. It might also re-download the old files if I changed where the files are stored. If you can figure out where they are supposed to go you can copy them over to avoid the re-downloading.
  • Open the databases in another program (see FAQ) and manually migrate the data.
  • Beg me to make a migration script.

Running sources directly

You can also run the .py files in the repo directly. If you want to do this I’m assuming you have enough proficiency with Python to figure it out. FYI, I use PyCharm to develop so might be easier to get it to work that way.

Building will build a .whl file and also clean up the build dirs for you.