Update for 2023

.gitignore

@@ -1,6 +1,5 @@
 *~
 *.log
-*.yaml
 
 lib64
 pip-selfcheck.json
@@ -9,6 +8,7 @@ throttle.ctrl
 user-password.py
 user-config.py
 pyvenv.cfg
+.env
 
 __pycache__/
 bin/

README.md

@@ -2,15 +2,16 @@ This bot adds initial information at the start of year for Wikimedia Sverige. It
 
 # Installation
 Install required libraries with pip:
-
-`$ pip install -r requirements.txt`
+```
+pip install -r requirements.txt
+```
 
 # Configuration
 A configuration file, `config.yaml` by default, is needed to run. `config.yaml.sample` has comments documenting the various parameters and can be used as a template.
 
 Configure Pywikibot, following the instructions on https://www.mediawiki.org/wiki/Manual:Pywikibot/user-config.py.
 
-To edit Phabricator, a Conduit API token is required. This can be generated in the user settings: `Settings` -> `Conduit API Tokens`.
+To edit Phabricator, a Conduit API token is required. This can be generated in the user settings: `Settings` -> `Conduit API Tokens`. The API token is read from environment variable `PHAB_API_TOKEN` which can be specified in the file `.env`.
 
 # Input Data
 ## Files
@@ -20,11 +21,15 @@ Two files are required to run the bot: one containing project information and on
 Information about programs, strategies and goals are fetched from a table on a wikipage, such as [this one from 2019](https://se.wikimedia.org/w/index.php?title=Verksamhetsplan_2019/Tabell_%C3%B6ver_program,_strategi_och_m%C3%A5l&oldid=75471). The code for this is specific for this particular table and would need to be adapted if the same information is represented in another way. Note that some information is stored in HTML comments.
 
 # Running
-The bot is run with the command
-
-    $ ./project_start.py project-file goal-file
-
-For flags, see command line help (`$ ./project_start.py --help`).
+The bot is run with the command:
+```
+./project_start.py project-file [goal-file]
+```
+
+For flags, see command line help:
+```
+./project_start.py --help
+```
 
 ## Logging
 The most important log messages are written to standard out. If you want more detailed logging, see the log file *project-start.log*.

config.yaml.wmse → config.yaml

@@ -6,10 +6,10 @@ project_columns:
     lead: Ansvarig
     e_mail: Mejlprefix
     project_number: Projektnummer
-    area: Program
+    program: Program
     swedish_name: Svenskt projektnamn
     english_name: Engelskt projektnamn
-    about_english: About the project
+    about_english: Mini-description of the project
     about_swedish: Om projektet
     project_start: Projektstart
     project_end: Projektslut
@@ -46,8 +46,8 @@ wiki:
               budget: budget
               finansiär_2: funder_2
               budget_2: budget_2
+          year_parameter: år
     year_pages:
-        operational_plan: Verksamhetsplan_<YEAR>/Tabell_över_program,_strategi_och_mål
         current_projects_template: Mall:Aktuella projekt <YEAR>
         simple:
             <YEAR>: Mall:Årsida
@@ -63,19 +63,6 @@ wiki:
         projects:
             title: Projekt <YEAR>
             template: Mall:Årsida för projekt
-        program_overview:
-            colours:
-                - "#339966"
-                - "#006699"
-                - "#990000"
-                - "#FF8C00"
-            title: Verksamhetsplan <YEAR>/Måluppfyllnad/Programöversikt
-            templates:
-                page: Mall:Programöversikt
-                program: Mall:Programöversikt/Program
-                strategy: Mall:Programöversikt/Strategi
-                goal: Mall:Programöversikt/Mål
-                project: Mall:Programöversikt/Projekt
         categories:
             general: Föreningen <YEAR>
             pages:
@@ -86,15 +73,13 @@ wiki:
                 Resor <YEAR>: Resor
                 Årsmöte <YEAR>: Årsmöte
                 Checklistor <YEAR>: Checklistor
-                Utbildning <YEAR>: Utbildning
                 Globala mätetal <YEAR>: Globala mätetal
         volunteer_tasks:
             title: Frivilliguppdrag <YEAR>
             template: Mall:Frivilliguppdrag år
     project_name_template: Mall:Projektnamn
     project_number_template: Mall:Projektid
 phab:
-    api_token: api-...
     api_url: https://phabricator.wikimedia.org/api
     parent_project_id: 2480
-    request_delay: 10
+    request_delay: 1

config.yaml.sample

@@ -39,8 +39,6 @@ wiki:
               # put and the name of the template to use for the goals.
               template_parameter: Template:Goals
     year_pages:
-        # Page where the operational plan can be found.
-        operational_plan:
         # Template where current projects are listed
         current_projects_template:
         # Map of pages that will be created by substituting
@@ -52,19 +50,6 @@ wiki:
         projects:
             title:
             template:
-        # Parameters for program overview page.
-        program_overview:
-            # Colours to use in the program headers.
-            colours:
-                - #123456
-            title:
-            templates:
-                # Template that is substed to create the page.
-                page:
-                # Templates that are used by the page template. Maps
-                # parameter name in the page template to template
-                # name.
-                parameter: Template
         # Year categories.
         categories:
             # This category is added to each category page.
@@ -85,8 +70,6 @@ wiki:
     project_number_template:
 # Parameters for Phabricator
 phab:
-    # API-token for Conduit.
-    api_token: api-...
     # URL to the API.
     api_url: https://.../api
     # Id of the project that created projects will be subprojects

phab.py

@@ -1,7 +1,9 @@
 import logging
 from time import sleep, time
+import os
 
 import requests
+from dotenv import load_dotenv
 
 
 class Phab:
@@ -23,6 +25,8 @@ def __init__(self, config, dry_run):
         self._config = config
         self._dry_run = dry_run
         self._last_request_time = 0.0
+        load_dotenv()
+        self._api_token = os.getenv("PHAB_API_TOKEN")
 
     def add_project(self, name, description):
         """Add project.
@@ -131,15 +135,15 @@ def _make_request(self, endpoint, parameters_dict):
         parameters = self._to_phab_parameters(parameters_dict)
         # Add placeholder API token to not reveal the real one in logs.
         logged_parameters = parameters.copy()
-        logged_parameters["api.token"] = "api-..."
+        logged_parameters["api.token"] = "api-REDACTED"
         logging.debug(
             "POST to Phabricator API on {}/{}: {}".format(
                 self._config["api_url"],
                 endpoint,
                 logged_parameters
             )
         )
-        parameters["api.token"] = self._config["api_token"]
+        parameters["api.token"] = self._api_token
         self._last_request_time = time()
         response = requests.post(
             "{}/{}".format(self._config["api_url"], endpoint),

project_start.py

@@ -291,7 +291,8 @@ def process_project(project_information, project_columns):
     wiki.add_project(
         project_information[project_columns["project_number"]],
         project_information[project_columns["swedish_name"]],
-        project_information[project_columns["english_name"]]
+        project_information[project_columns["english_name"]],
+        project_information[project_columns["program"]]
     )
 
 

requirements.txt

@@ -2,3 +2,4 @@ pywikibot==8.1.2
 pyyaml==6.0
 mwparserfromhell==0.6.4
 wikitables==0.5.5
+python-dotenv==1.0.0