pppindex/README.md
2021-12-10 13:40:42 +01:00

1.2 KiB

pppadindex

Generates templated publications based on pppadump

requirements

  • python3 / pip3 / python3-venv

installation

Recusively clone pppindex and pppadump:

$> git clone --recursive https://git.le-club-des-sans-sujets.org/Le-Club-des-Sans-Sujets/pppindex.git

Then set environment:

$> . setenv

The program will check your python3 environment and interactively asks some questions (if need is):

venv DOES NOT exists...
Setup venv? [y/N]> y
Creating python3 venv
Done.

The program will also check wether pppadum is install or not and interactively asks some questions (if need is):

pppadump IS NOT installed
pip install pppadump? [y/N]> y
Pip installing pppadump
Done.

When the environment is set, initialise the project with:

$> make init

The program then interactively asks some questions:

Please type the URL of the etherpad: 
	http://automatist.local:9001/
The APIKEY is the contents of the file APIKEY.txt in the etherpad folder
Please paste the APIKEY: 
	xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

usage

$> . setenv
$> make pull
$> make index