A generalized data labeling system for use in MediaWiki wikis
Project description
# Wiki Labels
This package provides the components of a generalized labeling service for
MediaWiki. There are two primary components, a user script to be used on
MediaWiki and a flask server for the gadget to converse with.
## Server
The flask server is intended to be hosted by a web server, but a dev server can
be started locally with
wikilabels dev_server
### Installation
#### Dependencies
Installation will require some additional packages to be available.
`sudo apt-get install postgresql-server-dev-all postgresql libffi-dev npm g++ python3-dev libmemcached-dev`
#### Database setup
You'll need to create a `wikilabels` user and database. Here's a sequence of
commands that works on a fresh install of postgres (note that `sudo` rights
will be required).
Create a wikilabels user
$ sudo useradd wikilabels
Switch to `postgres` user to run commands
$ sudo su postgres
$ psql
postgres=# CREATE USER wikilabels WITH PASSWORD 'something secure';
postgres=# CREATE DATABASE wikilabels;
postgres=# GRANT ALL PRIVILEGES ON DATABASE wikilabels to wikilabels;
postgres=# \q
$ exit
Switch to `wikilabels` user to load schema
$ sudo su wikilabels
$ psql
Copy-paste config/schema.sql into the command prompt.
Optionally, you can also load sample data into the database by copy-pasting config/schema-testdata.sql into the command prompt
### Installing javascript dependencies
$ npm install codemirror jquery oojs oojs-ui strftime yamljs
### Starting the dev server
$ wikilabels dev_server --config config-localdev.yaml
## Gadget
1. Go to one of the js subpages of your user page. You can choose a page such as these:
* [meta:User:`<Name>`/global.js](https://meta.wikimedia.org/wiki/Special:MyPage/global.js), which will be loaded in all wikis, in all skins
* [meta:User:`<Name>`/common.js](https://meta.wikimedia.org/wiki/Special:MyPage/common.js), which will be loaded only on Meta-wiki, in all skins
* [meta:User:`<Name>`/vector.js](https://meta.wikimedia.org/wiki/Special:MyPage/vector.js), which will be loaded only on Meta-wiki, in the vector skin
2. Copy the following to the page you have chosen:
```javascript
// [[File:User:EpochFail/WikiLabels.js]] (workaround for [[phab:T35355]])
mw.loader.load( '//labels.wmflabs.org/gadget/loader.js' );
```
3. Clear the cache of your browser.
This will import a live copy of the javascript.
## See also
* [meta:Wiki labels](https://meta.wikimedia.org/wiki/Wiki labels)
This package provides the components of a generalized labeling service for
MediaWiki. There are two primary components, a user script to be used on
MediaWiki and a flask server for the gadget to converse with.
## Server
The flask server is intended to be hosted by a web server, but a dev server can
be started locally with
wikilabels dev_server
### Installation
#### Dependencies
Installation will require some additional packages to be available.
`sudo apt-get install postgresql-server-dev-all postgresql libffi-dev npm g++ python3-dev libmemcached-dev`
#### Database setup
You'll need to create a `wikilabels` user and database. Here's a sequence of
commands that works on a fresh install of postgres (note that `sudo` rights
will be required).
Create a wikilabels user
$ sudo useradd wikilabels
Switch to `postgres` user to run commands
$ sudo su postgres
$ psql
postgres=# CREATE USER wikilabels WITH PASSWORD 'something secure';
postgres=# CREATE DATABASE wikilabels;
postgres=# GRANT ALL PRIVILEGES ON DATABASE wikilabels to wikilabels;
postgres=# \q
$ exit
Switch to `wikilabels` user to load schema
$ sudo su wikilabels
$ psql
Copy-paste config/schema.sql into the command prompt.
Optionally, you can also load sample data into the database by copy-pasting config/schema-testdata.sql into the command prompt
### Installing javascript dependencies
$ npm install codemirror jquery oojs oojs-ui strftime yamljs
### Starting the dev server
$ wikilabels dev_server --config config-localdev.yaml
## Gadget
1. Go to one of the js subpages of your user page. You can choose a page such as these:
* [meta:User:`<Name>`/global.js](https://meta.wikimedia.org/wiki/Special:MyPage/global.js), which will be loaded in all wikis, in all skins
* [meta:User:`<Name>`/common.js](https://meta.wikimedia.org/wiki/Special:MyPage/common.js), which will be loaded only on Meta-wiki, in all skins
* [meta:User:`<Name>`/vector.js](https://meta.wikimedia.org/wiki/Special:MyPage/vector.js), which will be loaded only on Meta-wiki, in the vector skin
2. Copy the following to the page you have chosen:
```javascript
// [[File:User:EpochFail/WikiLabels.js]] (workaround for [[phab:T35355]])
mw.loader.load( '//labels.wmflabs.org/gadget/loader.js' );
```
3. Clear the cache of your browser.
This will import a live copy of the javascript.
## See also
* [meta:Wiki labels](https://meta.wikimedia.org/wiki/Wiki labels)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wikilabels-0.2.0.tar.gz
(1.0 MB
view details)
Built Distribution
File details
Details for the file wikilabels-0.2.0.tar.gz
.
File metadata
- Download URL: wikilabels-0.2.0.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf3743d30fdf9687f074f3beff183aa4d2450949d957c9678b38d37747424219 |
|
MD5 | d973e72e2dd1da9afeb84aba3f36d375 |
|
BLAKE2b-256 | f6253b91185014f53a58c02122e198ba8faed10b3103a7f911d78e566976b08c |
File details
Details for the file wikilabels-0.2.0-py2.py3-none-any.whl
.
File metadata
- Download URL: wikilabels-0.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 2.6 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7257ff74abc4d5a9831815d94196af739afae745bc77fc37be8340c0194efe65 |
|
MD5 | 411311ec63963f98864244a359fb6313 |
|
BLAKE2b-256 | 0d00821ce50ab7efeaae717bd0ba6f485b45daae663b4a87f62ea50cc5425248 |