Merge pull request #15 from NeuroQuestAi/feature/v1.11.0

Feature/v1.11.0

Author: edersoncorbari

.gitignore

@@ -39,7 +39,6 @@ Thumbs.db
 # Specific directories and files #
 ##################################
 *.pyc
-*.lock
 *.vscode
 *.env
 *.bak

Pipfile

@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/NeuroQuestAi/five-factor-e/main/doc/neuro-quest.png" align="right" width="80" height="70"/>
+<img src="https://raw.githubusercontent.com/NeuroQuestAi/neuroquestai.github.io/main/brand/logo/neuroquest-orange-logo.png" align="right" width="80" height="80"/>
 
 # Five Factor E 🌊
 
@@ -8,7 +8,9 @@ https://neuroquest.ai)
 ![python 3][python_version]
 [![PyPi Downloads](https://static.pepy.tech/badge/five-factor-e)](https://pepy.tech/project/five-factor-e)
 [![Code style: Black](https://img.shields.io/badge/code%20style-Black-000000.svg)](https://github.com/psf/black)
+[![Packaged with Poetry][poetry-badge]](https://python-poetry.org/)
 
+[poetry-badge]: https://img.shields.io/badge/packaging-poetry-cyan.svg
 [python_version]: https://img.shields.io/static/v1.svg?label=python&message=3%20&color=blue
 
 <p align="center">
@@ -79,6 +81,14 @@ $ cd five-factor-e
 $ python3 -m pip install .
 ```
 
+or [Poetry](https://python-poetry.org/):
+
+```shell
+$ git clone https://github.com/NeuroQuestAi/five-factor-e.git
+$ cd five-factor-e
+$ poetry shell && poetry 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/NeuroQuestAi/five-factor-e/blob/main/data/README.md).
@@ -272,9 +282,7 @@ Note 🚩:
 
 ### Resources 📗
 
-  * http://www.personal.psu.edu/j5j/IPIP/ipipneo300.htm
-  * http://www.personal.psu.edu/j5j/IPIP/ipipneo120.htm
-  * http://www.personal.psu.edu/faculty/j/5/j5j/
+  * https://sites.psu.edu/drj5j/
   * https://ipip.ori.org/
   * https://osf.io/tbmh5/
   * https://github.com/kholia/IPIP-NEO-PI

README.md

@@ -1,7 +1,13 @@
-<img src="https://raw.githubusercontent.com/NeuroQuestAi/five-factor-e/main/doc/neuro-quest.png" align="right" width="80" height="70"/>
+<img src="https://raw.githubusercontent.com/NeuroQuestAi/neuroquestai.github.io/main/brand/logo/neuroquest-orange-logo.png" align="right" width="80" height="80"/>
 
 ### Releases 🎈
 
+Release **[1.11.0](https://github.com/NeuroQuestAi/five-factor-e/releases/tag/v1.11.0)**:
+
+* Refactoring calculate percent;
+* Revised README files;
+* Change company logo.
+
 Release **[1.10.0](https://github.com/NeuroQuestAi/five-factor-e/releases/tag/v1.10.0)**:
 
 * Refactoring on some code snippets;

RELEASES.md

@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/NeuroQuestAi/five-factor-e/main/doc/neuro-quest.png" align="right" width="80" height="70"/>
+<img src="https://raw.githubusercontent.com/NeuroQuestAi/neuroquestai.github.io/main/brand/logo/neuroquest-orange-logo.png" align="right" width="80" height="80"/>
 
 ### About data 📊
 

data/README.md

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

doc/big-five-neuro-quest.png

@@ -5,7 +5,7 @@
 __copyright__ = "Copyright NeuroQuest 2022-2023, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.10.0"
+__version__ = "1.11.0"
 __status__ = "production"
 
 from enum import IntEnum

doc/neuro-quest.png

@@ -5,7 +5,7 @@
 __copyright__ = "Copyright NeuroQuest 2022-2023, Big 5 Personality Traits"
 __credits__ = ["John A. Johnson", "Dhiru Kholia"]
 __license__ = "MIT"
-__version__ = "1.10.0"
+__version__ = "1.11.0"
 __status__ = "production"
 
 import copy