Uxie is a tool to build a database using Pokemon Showdown's usage stats.
- Install Python 2.7 or 3.5
- Install pip
- In the root directory of the project, run
pip install -r requirements.txt
Be sure you have an accessible instance of MySQL
Run uxie.py with your preferred python version while providing necessary arguments, for example :
Connects via mysql to localhost with user uxie and password secretpw to database uxiedb :
python uxie.py mysql localhost uxie secretpw uxiedb
These parameters are required, and must be in this order :
dbms host user password dbname
| Name | Values | Description |
|---|---|---|
| dbms | mysql |
DataBase Management System. Currently only supports mysql |
| host | Domain or IP | The machine on which to build the database |
| user | string | The username used to connect to the database |
| password | string | The password corresponding to the username |
| dbname | string | The name of the database to use |
| Flag | Description |
|---|---|
-h or --help |
Show the help and exits without doing anything else |
-V or --version |
Show the version number and exits without doing anything else |
-v or --verbose |
Describe actions done |
| Flag | Argument | Description |
|---|---|---|
-1 or --skip-download |
- | Skip the download phase |
-2 or --skip-parse |
- | Skip the parse and feed the DB phase |
-3 or --skip-index |
- | Skip the indexing DB phase |
-d or --directory |
DIRECTORY |
Save and load files from DIRECTORY. Default directory used is stats |
-a or --append |
- | Do not delete or create any table, only append data to existing ones |
| Flag | Argument(s) | Values | Description | Example |
|---|---|---|---|---|
-y |
YEAR [YEAR ...] |
an int >= 2014 |
Only treat files from the years listed by YEAR |
-y 2014 2015 |
-m |
MONTH [MONTH ...] |
an int between 1 and 12 |
Only treat files from the months listed by MONTH |
-m 1 2 3 10 11 12 |
-f |
FORMAT [FORMAT ...] |
a string |
Only treat files of the formats listed by FORMAT |
-f ou gen5ubers vgc2016 |
-g |
GXE [GXE ...] |
an int |
Only treat files of the minimal GXE of the values listed by GXE |
-g 0 1630 |
-t |
TYPE [TYPE ...] |
usage, moveset, metagame, leads, chaos |
Only treat files of the types listed by TYPE |
-t chaos moveset |
Warning : Using -t chaos currently takes an enormous amount of time. Do it only if you're sure you need these data.
Uxie is distributed under the terms of the MIT License.