Merge pull request #10 from rewire5-io/feature/v1.9.0

Feature/v1.9.0

Author: edersoncorbari

README.md

@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/neural7/five-factor-e/main/doc/neural7.png" align="right" width="80" height="70"/>
+<img src="https://raw.githubusercontent.com/rewire5-io/five-factor-e/main/doc/rewire5.png" align="right" width="80" height="70"/>
 
 # Five Factor E 🌊
 
@@ -10,7 +10,7 @@
 [python_version]: https://img.shields.io/static/v1.svg?label=python&message=3.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11%20&color=blue
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/neural7/five-factor-e/main/doc/big-five-neural7.png" alt="Representation of the Big Five"/>
+  <img src="https://raw.githubusercontent.com/rewire5-io/five-factor-e/main/doc/big-five-rewire5.png" alt="Representation of the Big Five"/>
 </p>
 
 This project assesses a person's 🗣 personality based on an inventory of questions. The project uses the **Big Five** theory using the [IPIP-NEO-300](http://www.personal.psu.edu/~j5j/IPIP/ipipneo300.htm) model created by **Lewis R. Goldberg** and [IPIP-NEO-120](http://www.personal.psu.edu/~j5j/IPIP/ipipneo120.htm) the shorter version developed by Professor **Dr. John A. Johnson**, this is a free representation of the [NEO PI-R™](https://en.wikipedia.org/wiki/Revised_NEO_Personality_Inventory).
@@ -21,7 +21,7 @@ The main idea of the project is to facilitate the use of **Python** developers w
 
 👉 *"That is wonderful, ...! Thank you for developing the Python version of the IPIP-NEO and making it publicly available. It looks like a great resource."* - Dr. Johnson
 
-Note 🚩: *The project is based on the work of **Dhiru Kholia**, and is an adaptation of [Neural7](https://github.com/neural7) for a version that can be reused in other projects of the company.*
+Note 🚩: *The project is based on the work of **Dhiru Kholia**, and is an adaptation of [ReWire5](https://github.com/rewire5-io) for a version that can be reused in other projects of the company.*
 
 ### Synopsis 🌐
 
@@ -59,7 +59,7 @@ Note 🚩: Some answers have the order of the [score reversed](https://ipip.ori.
 
 News about each version please look here:
 
-  * [Releases](https://github.com/neural7/five-factor-e/blob/main/RELEASES.md)
+  * [Releases](https://github.com/rewire5-io/five-factor-e/blob/main/RELEASES.md)
 
 ### Installation 🚀
 
@@ -72,14 +72,14 @@ $ python3 -m pip install --upgrade five-factor-e
 From source:
 
 ```shell
-$ git clone https://github.com/neural7/five-factor-e.git
+$ git clone https://github.com/rewire5-io/five-factor-e.git
 $ cd five-factor-e
 $ python3 -m pip install .
 ```
 
 ### How to use 🔥
 
-The construtor requires the questions model, whether it is the **300** model or short model with **120** questions. It also has the version to do simulations with the questions that are [reversed](https://ipip.ori.org/newScoringInstructions.htm). For this, you must turn the **test** variable from false to true, for more details on reverse scoring tests see section [Experiments with reverse scoring questions](https://github.com/neural7/five-factor-e/blob/main/data/README.md).
+The construtor requires the questions model, whether it is the **300** model or short model with **120** questions. It also has the version to do simulations with the questions that are [reversed](https://ipip.ori.org/newScoringInstructions.htm). For this, you must turn the **test** variable from false to true, for more details on reverse scoring tests see section [Experiments with reverse scoring questions](https://github.com/rewire5-io/five-factor-e/blob/main/data/README.md).
 
 | Parameters    | Type      | Description                                                       |
 | ------------- | --------- | ----------------------------------------------------------------- |
@@ -102,12 +102,12 @@ from ipipneo import IpipNeo
 ipip = IpipNeo(question=300)
 ```
 
-The answers must be in a *standardized json*, you can insert this template in the [data](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/answers.json) folder of the project. This dictionary contains random answers, used for testing purposes only. As an example, you can load the file with the **120** test responses:
+The answers must be in a *standardized json*, you can insert this template in the [data](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/answers.json) folder of the project. This dictionary contains random answers, used for testing purposes only. As an example, you can load the file with the **120** test responses:
 
 ```python
 import json, urllib.request
 
-data = urllib.request.urlopen("https://raw.githubusercontent.com/neural7"\
+data = urllib.request.urlopen("https://raw.githubusercontent.com/rewire5-io"\
    "/five-factor-e/main/data/IPIP-NEO/120/answers.json").read()
 
 answers120 = json.loads(data)
@@ -118,7 +118,7 @@ For the long inventory version with **300** items.
 ```python
 import json, urllib.request
 
-data = urllib.request.urlopen("https://raw.githubusercontent.com/neural7"\
+data = urllib.request.urlopen("https://raw.githubusercontent.com/rewire5-io"\
    "/five-factor-e/main/data/IPIP-NEO/300/answers.json").read()
 
 answers300 = json.loads(data)
@@ -200,7 +200,7 @@ An example of the output of the results:
 }
 ```
 
-Example of the complete output check here: [Big 5️⃣ Output](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/result.json)
+Example of the complete output check here: [Big 5️⃣ Output](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/result.json)
 
 ### Tests 🏗
 
@@ -227,14 +227,14 @@ $ pip install five-factor-e[quiz]
 Example output with graphics:
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/neural7/five-factor-e/feature/v1.5.0/doc/sample-light-1.png" alt="Big Five Results" border="1"/>
+  <img src="https://raw.githubusercontent.com/rewire5-io/five-factor-e/feature/v1.5.0/doc/sample-light-1.png" alt="Big Five Results" border="1"/>
 </p>
 
 *The complete result is saved in the run folder in json format*.
 
 ### About data 📊
 
-Inside the data [data](https://github.com/neural7/five-factor-e/blob/main/data/) directory, there are examples of questions and answers. The most important is the response data entry which must follow the pattern of this [file](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/answers.json). Example:
+Inside the data [data](https://github.com/rewire5-io/five-factor-e/blob/main/data/) directory, there are examples of questions and answers. The most important is the response data entry which must follow the pattern of this [file](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/answers.json). Example:
 
 ```json
 {
@@ -251,7 +251,7 @@ Inside the data [data](https://github.com/neural7/five-factor-e/blob/main/data/)
 }
 ```
 
-The id question field refers to the question in this [file](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/questions.json).
+The id question field refers to the question in this [file](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/questions.json).
 Obviously if you want you can change the translation of the question, *but don't change the ID of the question*.
 
 Note 🚩:
@@ -279,4 +279,4 @@ Note 🚩:
 
 ### Authors 👨‍💻
 
-  * [Ederson Corbari](mailto:e@neural7.io) 👽
+  * [Ederson Corbari](mailto:e@rewire5.io) 👽

RELEASES.md

@@ -1,45 +1,50 @@
-<img src="https://raw.githubusercontent.com/neural7/five-factor-e/main/doc/neural7.png" align="right" width="80" height="70"/>
+<img src="https://raw.githubusercontent.com/rewire5-io/five-factor-e/main/doc/rewire5-io.png" align="right" width="80" height="70"/>
 
 ### Releases 🎈
 
-Release **[1.8.0](https://github.com/neural7/five-factor-e/releases/tag/v1.8.0)**:
+Release **[1.9.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.9.0)**:
 
 * Leaving the json format more Pythonic;
 * Revised README files.
 
-Release **[1.7.0](https://github.com/neural7/five-factor-e/releases/tag/v1.7.0)**:
+Release **[1.8.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.8.0)**:
+
+* Leaving the json format more Pythonic;
+* Revised README files.
+
+Release **[1.7.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.7.0)**:
 
 * Leaving the age range between 10 to 110 years;
 * Revised README files.
 
-Release **[1.6.0](https://github.com/neural7/five-factor-e/releases/tag/v1.6.0)**:
+Release **[1.6.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.6.0)**:
 
 * Added to the return with the big-five averages: (low, average, high);
 * Refactoring of the reverse scored questions code;
 * Added to the quiz program, the verification of the translation of the questions (120 or 300);
 * Added new topics to PyPI setup.
 
-Release **[1.5.0](https://github.com/neural7/five-factor-e/releases/tag/v1.5.0)**:
+Release **[1.5.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.5.0)**:
 
 * Added support for original IPIP version with 300 items;
 * Refactoring of the program for testing the questions (quiz);
 * Added support for simulate question with reversed score;
 * Revised README files.
 
-Release **[1.4.0](https://github.com/neural7/five-factor-e/releases/tag/v1.4.0)**:
+Release **[1.4.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.4.0)**:
 
 * Adding language support Portuguese Brazil (pt-br) and Spain (es-es).
 
-Release **[1.3.0](https://github.com/neural7/five-factor-e/releases/tag/v1.3.0)**::
+Release **[1.3.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.3.0)**::
 
 * Fix of the normalization calculation of norms;
 * Fix of answers that have inversion, different weights.
 
-Release **[1.2.0](https://github.com/neural7/five-factor-e/releases/tag/v1.2.0)**:
+Release **[1.2.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.2.0)**:
 
 * Adding inventory tests (quiz).
 
-Release **[1.1.0](https://github.com/neural7/five-factor-e/releases/tag/v1.1.0)**:
+Release **[1.1.0](https://github.com/rewire5-io/five-factor-e/releases/tag/v1.1.0)**:
 
 * Initial version of IPIP-NEO;
 * Adding license information.

data/README.md

@@ -1,16 +1,16 @@
-<img src="https://raw.githubusercontent.com/neural7/five-factor-e/main/doc/neural7.png" align="right" width="80" height="70"/>
+<img src="https://raw.githubusercontent.com/rewire5-io/five-factor-e/main/doc/rewire5.png" align="right" width="80" height="70"/>
 
 ### About data 📊
 
 The data directory contains the artifacts used for the [IPIP-NEO](https://ipip.ori.org/) used by this library, in the short version with **120** items and the long version with **300** items.
 
-If you are thinking of using this library in your project, you should follow the standard question and answer files proposed in examples [120](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/answers.json) and [300](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/300/answers.json).
+If you are thinking of using this library in your project, you should follow the standard question and answer files proposed in examples [120](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/answers.json) and [300](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/300/answers.json).
 
-The translations of the questions are in the [translation](https://github.com/neural7/five-factor-e/tree/main/data/IPIP-NEO/120/translation) folder, as the translations happen, we will attach them to this directory. If you want to send a translation that is not in the repository, feel free to contribute with us following the [json file pattern](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/translation/questions-en-us.json).
+The translations of the questions are in the [translation](https://github.com/rewire5-io/five-factor-e/tree/main/data/IPIP-NEO/120/translation) folder, as the translations happen, we will attach them to this directory. If you want to send a translation that is not in the repository, feel free to contribute with us following the [json file pattern](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/translation/questions-en-us.json).
 
 ### Experiments with reverse scoring questions ⚡
 
-If you want to test and experiment with questions with the reverse order, you need to use the [example json file](https://github.com/neural7/five-factor-e/blob/main/data/IPIP-NEO/120/test/answers-1.json). Answers that have the key (reverse_scored = *1*) will have the reverse score ie: The value selected was *5*, it will be turned into *1*. You can read more about it here:
+If you want to test and experiment with questions with the reverse order, you need to use the [example json file](https://github.com/rewire5-io/five-factor-e/blob/main/data/IPIP-NEO/120/test/answers-1.json). Answers that have the key (reverse_scored = *1*) will have the reverse score ie: The value selected was *5*, it will be turned into *1*. You can read more about it here:
 
  * [https://ipip.ori.org/newScoringInstructions.htm](https://ipip.ori.org/newScoringInstructions.htm)
  * [https://ipip.ori.org/newMultipleconstructs.htm](https://ipip.ori.org/newMultipleconstructs.htm)
@@ -50,6 +50,6 @@ from ipipneo import IpipNeo
 IpipNeo(question=120, test=True).compute(sex="M", age=40, answers=answers120, compare=True)
 ```
 
-If you have any questions, please send us an email to: (**e at neural.io**) or create an issue reporting the question of the problem in the repository of this project (https://github.com/neural7/five-factor-e/issues).
+If you have any questions, please send us an email to: (**e at neural.io**) or create an issue reporting the question of the problem in the repository of this project (https://github.com/rewire5-io/five-factor-e/issues).
 
 Thanks!

doc/big-five-neural7.png doc/big-five-rewire5.pngdoc/big-five-neural7.png renamed to doc/big-five-rewire5.png

@@ -1,6 +1,6 @@
 """Import of the classes to be used."""
 
 __name__ = "five-factor-e"
-__version__ = "1.8.0"
+__version__ = "1.9.0"
 
 from ipipneo.ipipneo import IpipNeo

doc/neural7.png doc/rewire5.pngdoc/neural7.png renamed to doc/rewire5.png

@@ -1,11 +1,11 @@
 """Creation and scoring of the facets that make up the Big-Five."""
 
 __author__ = "Ederson Corbari"
-__email__ = "e@neural7.io"
-__copyright__ = "Copyright Neural7 2022, Big 5 Personality Traits"
+__email__ = "e@rewire5.io"
+__copyright__ = "Copyright ReWire5 2022-2023, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.8.0"
+__version__ = "1.9.0"
 __status__ = "production"
 
 from enum import IntEnum

ipipneo/__init__.py

@@ -1,11 +1,11 @@
 """It does the calculations to generate the IPIP-NEO results based on the questions and answers."""
 
 __author__ = "Ederson Corbari"
-__email__ = "e@neural7.io"
-__copyright__ = "Copyright Neural7 2022, Big 5 Personality Traits"
+__email__ = "e@rewire5.io"
+__copyright__ = "Copyright ReWire5 2022-2023, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.8.0"
+__version__ = "1.9.0"
 __status__ = "production"
 
 import copy
@@ -19,6 +19,7 @@
     organize_list_json,
     raise_if_age_is_invalid,
     raise_if_sex_is_invalid,
+    add_dict_footer,
 )
 
 
@@ -58,7 +59,9 @@ def evaluator(self, sex: str, age: int, score: list) -> dict:
         normc = Norm.calc(domain=self.domain(score=score), norm=norm)
         assert isinstance(normc, dict), "normc must be a dict"
 
-        distrib = self.distrib(size=len(score), b5=self.b5create(score=score), norm=norm)
+        distrib = self.distrib(
+            size=len(score), b5=self.b5create(score=score), norm=norm
+        )
         assert isinstance(distrib, dict), "distrib must be a dict"
 
         normalize = Norm.normalize(normc=normc, percent=Norm.percent(normc=normc))
@@ -79,10 +82,9 @@ def evaluator(self, sex: str, age: int, score: list) -> dict:
         return {
             "id": str(uuid.uuid4()),
             "theory": "Big 5 Personality Traits",
-            "model": "IPIP-NEO",
+            "model": "IPIP-NEO" if self._nquestion == 120 else "IPIP",
             "question": self._nquestion,
             "test": self._test,
-            "version": __version__,
             "person": {
                 "sex": sex,
                 "age": age,
@@ -96,6 +98,7 @@ def evaluator(self, sex: str, age: int, score: list) -> dict:
                     ]
                 },
             },
+            **add_dict_footer(),
         }
 
     def compute(self, sex: str, age: int, answers: dict, compare: bool = False) -> dict:
@@ -120,7 +123,9 @@ def compute(self, sex: str, age: int, answers: dict, compare: bool = False) -> d
             reversed = ReverseScoredCustom(answers=answers)
         else:
             reversed = (
-                ReverseScored120(answers=answers) if self._nquestion == 120 else ReverseScored300(answers=answers)
+                ReverseScored120(answers=answers)
+                if self._nquestion == 120
+                else ReverseScored300(answers=answers)
             )
         assert isinstance(reversed, dict), "reversed must be a dict"
 

ipipneo/facet.py

@@ -1,11 +1,11 @@
 """Auxiliary constants that are used in the library."""
 
 __author__ = "Ederson Corbari"
-__email__ = "e@neural7.io"
-__copyright__ = "Copyright Neural7 2022, Big 5 Personality Traits"
+__email__ = "e@rewire5.io"
+__copyright__ = "Copyright ReWire5 2022-2023, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.8.0"
+__version__ = "1.9.0"
 __status__ = "production"
 
 from enum import Enum, IntEnum

ipipneo/ipipneo.py

@@ -1,11 +1,11 @@
 """The standard with the rules of IPIP-NEO norms."""
 
 __author__ = "Ederson Corbari"
-__email__ = "e@neural7.io"
-__copyright__ = "Copyright Neural7 2022, Big 5 Personality Traits"
+__email__ = "e@rewire5.io"
+__copyright__ = "Copyright ReWire5 2022-2023, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.8.0"
+__version__ = "1.9.0"
 __status__ = "production"
 
 from enum import IntEnum