6-add-gplv3-licence (#9)

* Create license.md

* Update and rename license.md to LICENSE.md

* Update LICENSE.md

* Added GPLv3 Licence disclaimer at top of Go files.

* feat: added GPL v3 in README

README.md

@@ -2,51 +2,37 @@
 
 ## Description
 
-Rimo contains tools that helps creating a *masking.yaml* for [PIMO](https://github.com/CGI-FR/PIMO).
-It works as a 6 steps process :
-![rimo steps](.github/img/rimo_steps.png "rimo steps")
+Rimo contains a series of tools that helps to create a *masking.yaml* for [PIMO](https://github.com/CGI-FR/PIMO).
+<!-- It works as a 6 steps process : -->
+<!-- ![rimo steps](.github/img/rimo_steps.png "rimo steps") -->
 
-1. `gather` : orchestrate LINO to extract table of the database into a *.jsonl* file
-2. `analyse` : extract meaningful information on database from *.jsonl*
-3. `export` : dump data into an *Excel* file which serves as a configuration means
-4. `import` : load, store and verify inputted data of the *Excel* file into a *.yaml* file
-5. `build` : create a *pimo_masking.yaml* from *.yaml*
-6. `script` : build a bash script to execute pipeline for PIMO
+<!-- 1. `analyse` : extract meaningful information on database from *.jsonl* -->
 
 <!-- ## Installation
 `rimo` command line work in relative project's directory, like `git` or `docker` -->
 
 ## Usage
 
-### `rimo analyser`
+### `rimo analyse`
 
 ```console
-// to be defined
+rimo analyse input output
 ```
 
-- `input` : path to a directory or file containing to *jsonl* files
-- `output` : optional path to output. If none, same name and directory as input. If directory, same name as input.
+- `input` : path to a directory containing to *jsonl* files
+- `output` : path to a directory where output the *.yaml* file
 
 **input.jsonl** is a JSON single line that contains a pair of (column_name, value) for every row of the database table
 
 **output.yaml** contain various metrics on table's columns and a small default configuration for PIMO. An example can be found in *src/unit_test/testcase_output.yaml*.
 
-### `rimo exporter`
+### `rimo jsonschema`
 
-```console
-// to be defined
-```
-
-- `input` : path to a *yaml* file
-- `output` : optional path to output. If none, same name and directory as input. If directory, same name as input.
-
-**input.yaml** contains information on database generated by `analyser`
-
-**output.xlsx** is an Excel file where input is dumped.
+Generate the json schema of rimo.
 
 ## Tests
 
-To implement : Venom tests
+To run tests execute `neon test-int`.
 
 ## Project status
 
@@ -59,4 +45,17 @@ Pull requests are welcome. For major changes, please open an issue first to disc
 
 ## License
 
-TODO
+Copyright (C) 2023 CGI France
+
+PIMO is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+PIMO is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+ along with PIMO.  If not, see <http://www.gnu.org/licenses/>.

cmd/rimo/main.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package main
 
 import (

pkg/analyse/analyse.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse
 
 import (

pkg/analyse/analyse_test.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse_test
 
 import (

pkg/analyse/export.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse
 
 import (

pkg/analyse/export_test.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse_test
 
 import (

pkg/analyse/load.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse
 
 import (

pkg/analyse/load_test.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse_test
 
 import (

pkg/analyse/metrics.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse
 
 import (

pkg/analyse/metrics_test.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package analyse_test
 
 import (

pkg/model/model.go

@@ -1,3 +1,20 @@
+// Copyright (C) 2023 CGI France
+//
+// This file is part of RIMO.
+//
+// RIMO is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// RIMO is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with RIMO.  If not, see <http://www.gnu.org/licenses/>.
+
 package model
 
 import (