Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.32 KB

getting-started.md

File metadata and controls

54 lines (37 loc) · 2.32 KB

Getting started

This file is the entry point you are looking for if you are interested in the PPP but you do not know where to start, whether you want to deploy your own instance of the PPP or you want to write a plugin.

Understanding the PPP

Our website documentation is the best place to start. You can read here our reports and presentations.

Basically, the PPP is made of a core and modules, each running as an HTTP server. The core has a configuration file containing the URL of each module, allowing it to query them.

Installing the PPP

This section is intended to people who want to deploy their own instance of the PPP. You might find it useful if you want to develop plugins too, in order to test the integration of your plugin.

You can find the documentation in our Deployment repository which contains all the script we use and the commands we run altogether. Hopefully, that's all you need to know. Otherwise, feel free to contact us.

Writing modules

We wrote very useful libraries that allow you to focus on your code instead of administrative details (ie. interacting with the core). These libraries are available in PHP and Python.

We recommand that you use Python, as we wrote more modules in Python (so you can use them as examples), and they are also simpler than the Wikidata module (which is the one written in PHP).

We also wrote a tutorial for writing your own module.

Consider reading the spell checker or the CAS, for instance

You can find a script for creating the structure of a Python module in the scripts repository. It is named create_python_module.py; just download it, run it in a terminal and follow the instructions.

Finally, you need to understand the data model. Understanding how communications work may be useful too.