Initial commit

Author: ajparsons

.devcontainer/devcontainer.json

@@ -3,13 +3,18 @@
 	"build": {
 		"dockerfile": "../Dockerfile"
 	},
-	"extensions": [	
-		"ms-vscode.test-adapter-converter",
-		"bungcip.better-toml",
-		"ms-python.python",
-		"ms-python.vscode-pylance",
-		"ms-azuretools.vscode-docker",
-		"valentjn.vscode-ltex",
-		"mhutchie.git-graph"
-	]
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-vscode.test-adapter-converter",
+				"bungcip.better-toml",
+				"ms-python.python",
+				"ms-python.vscode-pylance",
+				"ms-azuretools.vscode-docker",
+				"valentjn.vscode-ltex",
+				"mhutchie.git-graph",
+				"charliermarsh.ruff"
+			]
+		}
+	}
 }

.vscode/settings.json

@@ -1,12 +1,10 @@
 {
-    "python.linting.pylintEnabled": true,
     "python.defaultInterpreterPath": "/usr/local/bin/python",
     "python.terminal.activateEnvironment": false,
-    "python.formatting.provider": "black",
     "python.analysis.typeCheckingMode": "strict",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-        "source.organizeImports": true
+        "source.organizeImports": "explicit"
     },
     "git.pullTags": false,
     "ltex.language": "en-GB",
@@ -27,11 +25,6 @@
         "**/templates/**/*": "django-txt",
         "**/requirements{/**,*}.{txt,in}": "pip-requirements"
     },
-    "python.linting.pylintArgs": [
-        "--max-line-length=88",
-        "--disable=C0103,E1101,E1123,W0102",
-    ],
-    "jupyter.jupyterServerType": "local",
     "[markdown]": {
         "editor.quickSuggestions": {
             "comments": "on",

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10-bullseye
+FROM python:3.9-bullseye
 
 ENV DEBIAN_FRONTEND noninteractive
 COPY pyproject.toml poetry.loc[k] /
@@ -8,4 +8,4 @@ RUN curl -sSL https://install.python-poetry.org | python - && \
     poetry config virtualenvs.create false && \
     poetry self add poetry-bumpversion && \
     poetry install && \
-    echo "/workspaces/mysoc-popolo/src/" > /usr/local/lib/python3.10/site-packages/mysoc_popolo.pth
+    echo "/workspaces/mysoc-popolo/src/" > /usr/local/lib/python3.9/site-packages/mysoc_popolo.pth

README.md

@@ -1,3 +1,102 @@
-# mysoc-popolo
+# mysoc-validator
 
-null
+A set of pydantic based validators for common mySociety democracy formats.
+
+The long term goal is to consolidate different scripts behind a common validation system.
+
+## Transcripts
+
+Python validator and handler for 'publicwhip' style transcript format. 
+
+Haven't ensured it can do round trips yet - but can read and write. Needs tests.
+
+```python
+from mysoc_validator import DailyRecord
+
+transcript = DailyRecord.from_path(<path to xml file>)
+```
+
+```bash
+python -m validate_transcript <path-to-transcript.xml>
+```
+
+## Popolo
+
+A pydantic based validator for main mysociety people.json file (which mostly follows the popolo standard with a few extra bits).
+
+Validates:
+
+- Basic structure
+- Unique IDs and ID Patterns
+- Foreign key relationships between objects.
+
+It also has support for looking up from name or indentifer to person (see tests), and new ID generation for membership. 
+
+```python
+from mysoc_validator import Popolo
+
+popolo = Popolo.from_path(<path to people.json>)
+```
+
+```bash
+python -m validate_popolo <path-to-people.json>
+```
+
+### People.json
+
+The currently committed people.json is not the authoriative one - currently has some tweaks to pass validation. 
+
+In the long run - do not store this in this repo, fetch the live one before running tests.
+
+curl -o data/people.json https://raw.githubusercontent.com/mysociety/parlparse/master/members/people.json
+
+Changes needed to parlparse version:
+
+- Add chambers
+- replace additional_names and additional__name with additional_name
+- (not implimented yet) - role for all new constituencies and remove optional in the validator. 
+
+```json
+  {
+      "classification": "chamber",
+      "id": "house-of-commons",
+      "identifiers": [],
+      "name": "House of Commons"
+    },
+    {
+      "classification": "chamber",
+      "id": "house-of-lords",
+      "identifiers": [],
+      "name": "House of Lords"
+    },
+    {
+      "classification": "chamber",
+      "id": "scottish-parliament",
+      "identifiers": [],
+      "name": "Scottish Parliament"
+    },
+    {
+      "classification": "chamber",
+      "id": "welsh-parliament",
+      "identifiers": [],
+      "name": "Senedd"
+    },
+    {
+      "classification": "chamber",
+      "id": "northern-ireland-assembly",
+      "identifiers": [],
+      "name": "Northern Ireland Assembly"
+    },
+    {
+      "classification": "chamber",
+      "id": "crown",
+      "identifiers": [],
+      "name": "Crown"
+    },
+    {
+      "classification": "metro",
+      "id": "london-assembly",
+      "identifiers": [],
+      "name": "London Assembly"
+    },
+```