@tricoteuses/senat 0.3.2 → 1.1.1

package/README.md

@@ -1,3 +1,58 @@
 # Tricoteuses-Senat
 
 ## _Handle French Sénat's open data_
+
+## Installation
+
+```bash
+git clone https://git.en-root.org/tricoteuses/tricoteuses-senat
+cd tricoteuses-senat/
+```
+
+Create a `.env` file to set PostgreSQL database informations and other configuration variables (you can use `example.env` as a template). Then
+
+```bash
+npm install
+```
+
+### Database creation
+
+#### Using Docker
+
+```bash
+docker run --name local-postgres -d -p 5432:5432 -e POSTGRES_PASSWORD=$YOUR_CUSTOM_DB_PASSWORD postgres
+# Default Postgres user is postgres
+# But scripts require an "opendata" role
+docker exec -it local-postgres psql -U postgres -c "CREATE ROLE opendata;"
+```
+
+## Usage
+
+### Retrieval, cleaning & import of open data from Sénat
+
+```bash
+mkdir ../senat-data/
+npx babel-node --extensions ".ts" --max-old-space-size=4096 -- src/scripts/retrieve_open_data.ts --fetch --unzip --repair-encoding ../senat-data/
+npx babel-node --extensions ".ts" -- src/scripts/retrieve_open_data.ts --import ../senat-data/
+npx babel-node --extensions ".ts" -- src/scripts/fix_db.ts --updateSchema
+npx babel-node --extensions ".ts" -- src/scripts/convert_data.ts ../senat-data/ [--categories DosLeg]
+```
+
+## Retrieval of sénateurs' pictures from Sénat's website
+
+```bash
+npx babel-node --extensions ".ts" -- src/scripts/retrieve_senateurs_photos.ts --fetch ../senat-data/
+```
+
+### Retrieval & cleaning of bills from Sénat HTML pages
+
+```bash
+npx babel-node --extensions ".ts" -- src/scripts/retrieve_textes.ts ../senat-data/
+```
+
+### Generation of raw types from SQL schema.
+
+To be run after database has been fixed (`src/scripts/fix_db.ts --updateSchema`).
+```bash
+npx babel-node --extensions ".ts" -- src/scripts/retrieve_open_data.ts --schema ../senat-data/
+```

package/lib/aggregates.d.ts

@@ -0,0 +1,54 @@
+import { Ses, Sub, TxtAmeli } from './types/ameli';
+import { Debat } from './types/debats';
+import { Ass, Aud, Auteur, DateSeance, DecCoc, DenRap, DocAtt, Ecr, EtaLoi, LecAss, LecAssRap, Lecture, Loi, Org, OriTxt, Qua, Rap, Scr, Texte, TypAtt, TypLec, TypLoi, TypTxt, TypUrl } from './types/dosleg';
+import { Question } from './types/questions';
+import { Sen } from './types/sens';
+export declare const allFollows: string[];
+export declare class Aggregator {
+    follow: Set<string>;
+    objectByIdByTableName: {
+        [name: string]: {
+            [id: string]: object;
+        };
+    };
+    requestedIdsByTableName: {
+        [name: string]: Set<string>;
+    };
+    visitedIdsByTableName: {
+        [name: string]: Set<string>;
+    };
+    constructor(follow: Set<string>);
+    addAss(ass: Ass): void;
+    addAud(aud: Aud): void;
+    addAuteur(auteur: Auteur): void;
+    addDateSeance(dateSeance: DateSeance): void;
+    addDebat(debat: Debat): void;
+    addDeccoc(deccoc: DecCoc): void;
+    addDenrap(denrap: DenRap): void;
+    addDocatt(docatt: DocAtt): void;
+    addEcr(ecr: Ecr): void;
+    addEtaloi(etaloi: EtaLoi): void;
+    addLecass(lecass: LecAss): void;
+    addLecassrap(lecassrap: LecAssRap): void;
+    addLecture(lecture: Lecture): void;
+    addLoi(loi: Loi): void;
+    addOrg(org: Org): void;
+    addOritxt(oritxt: OriTxt): void;
+    addQua(qua: Qua): void;
+    addQuestion(question: Question): void;
+    addRap(rap: Rap): void;
+    addScr(scr: Scr): void;
+    addSen(sen: Sen): void;
+    addSes(ses: Ses): void;
+    addSub(sub: Sub): void;
+    addTexte(texte: Texte): void;
+    addTxtAmeli(txtAmeli: TxtAmeli): void;
+    addTypatt(typatt: TypAtt): void;
+    addTyplec(typlec: TypLec): void;
+    addTyploi(typloi: TypLoi): void;
+    addTyptxt(typtxt: TypTxt): void;
+    addTypurl(typurl: TypUrl): void;
+    getAll(): Promise<void>;
+    request(tableName: string, id: string): void;
+    toJson(): any;
+}