Merge pull request #19 from ThreeSixtyGiving/refactor-to-minimal

Refactor to minimal

.github/workflows/taxonomy-and-examples.yml

@@ -24,8 +24,8 @@ jobs:
     - name: Check Taxanomy meets Taxonomy Schema
       run: jsonschema -i taxonomy/taxonomy.json taxonomy/schema/taxonomyschema.json
     # Check all examples match compiled schema
-    - name: Compile
-      run:  "python compile.py"
-    - name: Check all examples match compiled schema
-      run: "for f in examples/*; do   echo \"File: $f\"; jsonschema -i $f _compiled/360-giving-schema-including-extension.json || exit 1;   done"
-
+    #    - name: Compile
+    #      run:  "python compile.py"
+    #    - name: Check all examples match compiled schema
+    #      run: "for f in examples/*; do   echo \"File: $f\"; jsonschema -i $f _compiled/360-giving-schema-including-extension.json || exit 1;   done"
+    #

Makefile

@@ -0,0 +1,6 @@
+.PHONY: default taxonomy-codelist
+
+default: taxonomy-codelist
+
+taxonomy-codelist: ./taxonomy/taxonomy.json
+	@jq '[ .population_groups[].categories[] | {code,name,description}, (.sub_categories[]) ]' ./taxonomy/taxonomy.json | jq -r '["Code","Title","Description"],(.[] | [ .code, .name, .description ]) | @csv' > ./codelists/taxonomyCodes.csv

README.md

@@ -1,15 +1,23 @@
 # 360-dei
 
-## Publishing or using DEI data with the ThreeSixtyGiving data standard
+This is the repo for the DEI Extension for 360Giving
 
-Please see our user docs at https://360-dei.readthedocs.io/en/latest/#
+## Maintaining this extension
 
-## Developing this standard
+This section contains instructions on maintaining this extension,
 
-This uses git submodules; after checking out this code run:
+### Generating the taxonomyCodes.csv codelist file from taxonomy.json
 
-    git submodule init
-    git submodule update
+The DEI taxonomy codes are hierarchical and thus modelled using JSON (`taxonomy/taxonomy.json`), but this cannot be used for validation since codelist files must be in CSV format.
 
+In order to avoid maintaining two separate copies of the taxonomy codes and keeping them in sync; it's better to generate the validation codelist (`codelists/taxonomyCodes.csv`) directly from the JSON file.
 
+For simplicity, brevity, and speed, this is accomplished using [jq](https://jqlang.github.io/jq/) inside of the `Makefile`. Just run either `make` or `make taxonomy-codes` in your terminal when at the root of the repository. Historically, this was previously accomplished using a [python script](https://github.com/ThreeSixtyGiving/360-dei/commit/c5330dd078f5636cfbb15a8eb4b84bcef6437a07#diff-b27f53041b80d97ae35d861e86e9774a2f71bedf18eef3ff91ab66cc8155d1a3).
 
+You can install jq easily on most systems, see the [download page](https://jqlang.github.io/jq/download/).
+
+If the structure of the taxonomy JSON file changes, the jq command will need to be updated to match. If the location of the taxonomy JSON file changes, the Makefile will need to be updated to match.
+
+```bash
+jq '[ .population_groups[].categories[] | {code,name,description}, (.sub_categories[]) ]' ./taxonomy/taxonomy.json | jq -r '["Code","Title","Description"],(.[] | [ .code, .name, .description ]) | @csv' > ./codelists/taxonomyCodes.csv
+```

codelists/taxonomyCodes.csv

@@ -1,74 +1,74 @@
-Code,Title,Description
-DEI010000,"Communities experiencing racial inequity","Organisations working on racial justice or supporting people from multiple communities"
-DEI010100,"Black / African / Caribbean / Black British","Mixed Black/ Black British"
-DEI010110,"African",""
-DEI010120,"Caribbean",""
-DEI010199,"Any other Black/ African/ Caribbean background",""
-DEI010200,"Mixed","Mixed groups"
-DEI010210,"White and Black",""
-DEI010220,"White and Asian",""
-DEI010299,"Any other Mixed / Multiple ethnic background",""
-DEI010300,"Asian / Asian British","Mixed Asian/ Asian British"
-DEI010310,"Indian",""
-DEI010320,"Pakistani",""
-DEI010330,"Bangladeshi",""
-DEI010340,"Chinese",""
-DEI010399,"Any other Asian background",""
-DEI019900,"Other Group experiencing ethnic or racial inequity",""
-DEI019910,"Arab",""
-DEI019920,"Jewish",""
-DEI019930,"Gypsy, Roma and Traveller Communities",""
-DEI019999,"Any other Ethnic group",""
-DEI020000,"Disabled people","Working with people across multiple disabilities"
-DEI020100,"Physical Impairment","Working with people with multiple or different physical impairments"
-DEI020110,"Mobility","Physical/mobility impairment, such as a difficulty using your arms or mobility issues which require you to use a wheelchair or crutches"
-DEI020120,"Visual impairment/ partial sight/sight loss","Visual impairment, such as being blind or having a serious visual impairment"
-DEI020130,"Hard of hearing/ deaf/ hearing loss","Hearing impairment, such as being deaf or having a serious hearing impairment"
-DEI020140,"Speech impairment","Impaired ability to produce speech sounds"
-DEI020200,"Mental Health","Mental health condition or experience, such as depression or psychosis or addiction that impacts people’s lives"
-DEI020300,"Cognitive differences","Multiple or different cognitive differences"
-DEI020310,"Learning disability","A reduced intellectual ability and difficulty with everyday activities which affects someone for their whole life, such as Down’s Syndrome"
-DEI020320,"Learning difficulty","Learning difficulties such as dyslexia and ADHD"
-DEI020330,"Neurodivergent","Cognitive difference such as autistic spectrum disorder where individuals are impacted by the social environment"
-DEI020400,"Health","Long-standing illness or health condition, such as cancer, HIV, diabetes, chronic heart disease or epilepsy, or other rare conditions"
-DEI029900,"Other","Other - An impairment, medical condition or environmental disadvantage that is not listed above"
-DEI030000,"Faith","Interfaith and multi-faith groups"
-DEI030100,"Catholic","People who describe their faith as Catholic or Roman Catholic"
-DEI030200,"Protestant","Anglicans, Adventists, Baptists, Methodists, Pentecostals, Presbyterians, Religious Society of Friends, Reformed Churches and other Protestant denominations"
-DEI030300,"Other Christian denominations","Orthodox and other denominations"
-DEI030400,"Buddhist",""
-DEI030500,"Hindu",""
-DEI030600,"Jewish",""
-DEI030700,"Muslim",""
-DEI030800,"Sikh",""
-DEI030900,"Atheist",""
-DEI031000,"Agnostic",""
-DEI039900,"Other","Other faiths and beliefs"
-DEI040000,"LGBT+ People","Working with LGBT+ people with multiple identities"
-DEI040100,"Bisexual people","All bisexual people"
-DEI040110,"Bisexual men",""
-DEI040120,"Bisexual women",""
-DEI040200,"Gay men",""
-DEI040300,"Lesbian/gay women",""
-DEI040400,"Transgender people","All transgender people"
-DEI040410,"Trans men",""
-DEI040420,"Trans women",""
-DEI040500,"Non-binary people",""
-DEI049900,"Other","Other LGBT+ People, including queer and intersex people"
-DEI050000,"Migrants","Migrants with multiple status"
-DEI050100,"Asylum seekers",""
-DEI050200,"Refugees",""
-DEI050300,"Undocumented People",""
-DEI059900,"Other Migrants","This includes other migrants with official immigration status, e.g. international students; and who are naturalised British"
-DEI060000,"Older People","Typically those aged 60 and over"
-DEI070000,"Children and Young People","Typically people under 26 but sometimes people under 19"
-DEI070100,"Young adults","Typically young people from 16 to 25 years of age"
-DEI070200,"Young people","Typically young people from 8 to 25"
-DEI070300,"Children","Under 16"
-DEI070400,"Infants","Under 2 years of age"
-DEI080000,"People who are educationally or economically disadvantaged","This will be defined by the organisation, such as children eligible for free school meals or for adults were eligible for free school meals as a child, families receiving benefits or universal credit, people who are homeless, people who did not complete formal education or otherwise considered in deprivation or poverty etc."
-DEI090000,"Women and girls","Those who identify and live as women and girls"
-DEI700000,"Welsh Language Speaking",""
-DEI800010,"The Protestant community",""
-DEI800020,"The Catholic community",""
-DEI800030,"Neither",""
+"Code","Title","Description"
+"DEI010000","Communities experiencing racial inequity","Organisations working on racial justice or supporting people from multiple communities"
+"DEI010100","Black / African / Caribbean / Black British","Mixed Black/ Black British"
+"DEI010110","African",""
+"DEI010120","Caribbean",""
+"DEI010199","Any other Black/ African/ Caribbean background",""
+"DEI010200","Mixed","Mixed groups"
+"DEI010210","White and Black",""
+"DEI010220","White and Asian",""
+"DEI010299","Any other Mixed / Multiple ethnic background",""
+"DEI010300","Asian / Asian British","Mixed Asian/ Asian British"
+"DEI010310","Indian",""
+"DEI010320","Pakistani",""
+"DEI010330","Bangladeshi",""
+"DEI010340","Chinese",""
+"DEI010399","Any other Asian background",""
+"DEI019900","Other Group experiencing ethnic or racial inequity",""
+"DEI019910","Arab",""
+"DEI019920","Jewish",""
+"DEI019930","Gypsy, Roma and Traveller Communities",""
+"DEI019999","Any other Ethnic group",""
+"DEI020000","Disabled people","Working with people across multiple disabilities"
+"DEI020100","Physical Impairment","Working with people with multiple or different physical impairments"
+"DEI020110","Mobility","Physical/mobility impairment, such as a difficulty using your arms or mobility issues which require you to use a wheelchair or crutches"
+"DEI020120","Visual impairment/ partial sight/sight loss","Visual impairment, such as being blind or having a serious visual impairment"
+"DEI020130","Hard of hearing/ deaf/ hearing loss","Hearing impairment, such as being deaf or having a serious hearing impairment"
+"DEI020140","Speech impairment","Impaired ability to produce speech sounds"
+"DEI020200","Mental Health","Mental health condition or experience, such as depression or psychosis or addiction that impacts people’s lives"
+"DEI020300","Cognitive differences","Multiple or different cognitive differences"
+"DEI020310","Learning disability","A reduced intellectual ability and difficulty with everyday activities which affects someone for their whole life, such as Down’s Syndrome"
+"DEI020320","Learning difficulty","Learning difficulties such as dyslexia and ADHD"
+"DEI020330","Neurodivergent","Cognitive difference such as autistic spectrum disorder where individuals are impacted by the social environment"
+"DEI020400","Health","Long-standing illness or health condition, such as cancer, HIV, diabetes, chronic heart disease or epilepsy, or other rare conditions"
+"DEI029900","Other","Other - An impairment, medical condition or environmental disadvantage that is not listed above"
+"DEI030000","Faith","Interfaith and multi-faith groups"
+"DEI030100","Catholic","People who describe their faith as Catholic or Roman Catholic"
+"DEI030200","Protestant","Anglicans, Adventists, Baptists, Methodists, Pentecostals, Presbyterians, Religious Society of Friends, Reformed Churches and other Protestant denominations"
+"DEI030300","Other Christian denominations","Orthodox and other denominations"
+"DEI030400","Buddhist",""
+"DEI030500","Hindu",""
+"DEI030600","Jewish",""
+"DEI030700","Muslim",""
+"DEI030800","Sikh",""
+"DEI030900","Atheist",""
+"DEI031000","Agnostic",""
+"DEI039900","Other","Other faiths and beliefs"
+"DEI040000","LGBT+ People","Working with LGBT+ people with multiple identities"
+"DEI040100","Bisexual people","All bisexual people"
+"DEI040110","Bisexual men",""
+"DEI040120","Bisexual women",""
+"DEI040200","Gay men",""
+"DEI040300","Lesbian/gay women",""
+"DEI040400","Transgender people","All transgender people"
+"DEI040410","Trans men",""
+"DEI040420","Trans women",""
+"DEI040500","Non-binary people",""
+"DEI049900","Other","Other LGBT+ People, including queer and intersex people"
+"DEI050000","Migrants","Migrants with multiple status"
+"DEI050100","Asylum seekers",""
+"DEI050200","Refugees",""
+"DEI050300","Undocumented People",""
+"DEI059900","Other Migrants","This includes other migrants with official immigration status, e.g. international students; and who are naturalised British"
+"DEI060000","Older People","Typically those aged 60 and over"
+"DEI070000","Children and Young People","Typically people under 26 but sometimes people under 19"
+"DEI070100","Young adults","Typically young people from 16 to 25 years of age"
+"DEI070200","Young people","Typically young people from 8 to 25"
+"DEI070300","Children","Under 16"
+"DEI070400","Infants","Under 2 years of age"
+"DEI080000","People who are educationally or economically disadvantaged","This will be defined by the organisation, such as children eligible for free school meals or for adults were eligible for free school meals as a child, families receiving benefits or universal credit, people who are homeless, people who did not complete formal education or otherwise considered in deprivation or poverty etc."
+"DEI090000","Women and girls","Those who identify and live as women and girls"
+"DEI700000","Welsh Language Speaking",""
+"DEI800010","The Protestant community",""
+"DEI800020","The Catholic community",""
+"DEI800030","Neither",""