Add rudimentary script for generating the forum archive.
This commit is contained in:
27
README.md
27
README.md
@@ -1,2 +1,27 @@
|
||||
# Glitch City Laboratories (2003 - 2020) - Epilogue
|
||||
This repository contains the tickets, scripts, and documentation for the end of Glitch City Laboratories.
|
||||
This repository contains the tickets, scripts, and documentation for the end of Glitch City Laboratories.
|
||||
|
||||
## Installation
|
||||
`pip install -e .`
|
||||
|
||||
## Standalone Epilogue Scripts
|
||||
Run these before running commands from the epilogue package.
|
||||
|
||||
#### Wiki Data
|
||||
##### `find_data`
|
||||
Run this locally (it uses the MediaWiki HTTP API). Finds all pages in categories related to Pokemon generations 1 - 4 that have been edited since 31 March 2020.
|
||||
|
||||
#### Forum Data (`forum` directory)
|
||||
#### `dump_forum_data`
|
||||
Run this on a server with access to a Glitch City Laboratories database. It will dump the table schemas and data into several .sql files. Place these in the `forum` directory.
|
||||
|
||||
#### `create_sqlite_database`
|
||||
Run this locally, after the `dump_forum_data` script has been run on the Glitch City Laboratories server and the dumps copied to the `forum` directory (same directory as this script). A file called `forum.sqlite` will be generated from the MariaDB dumps. This sqlite database is required for generating the static archive later.
|
||||
|
||||
Make sure the `mysql2sqlite` submodule is initialized and install `mawk` for the best results.
|
||||
|
||||
## Epilogue Package
|
||||
|
||||
## Misc Scripts
|
||||
### `get_pms.php`
|
||||
This is installed on Glitch City Laboratories and allows any logged-in user to export their PM inbox into a HTML export.
|
Reference in New Issue
Block a user