pelican-nlp 0.2.4__tar.gz → 0.2.6__tar.gz

{pelican_nlp-0.2.4/pelican_nlp.egg-info → pelican_nlp-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pelican_nlp
-Version: 0.2.4
+Version: 0.2.6
 Summary: Preprocessing and Extraction of Linguistic Information for Computational Analysis
 Author-email: Yves Pauli <yves.pauli@gmail.com>
 License-Expression: CC-BY-NC-4.0
@@ -65,6 +65,18 @@ pelican_nlp stands for "Preprocessing and Extraction of Linguistic Information f
 Installation
 ============
 
+Create conda environment
+
+.. code-block:: bash
+
+    conda create -n pelican-nlp python=3.10
+
+Activate environment
+
+.. code-block:: bash
+
+    conda activate pelican-nlp
+
 Install the package using pip:
 
 .. code-block:: bash
@@ -80,12 +92,12 @@ For the latest development version:
 Usage
 =====
 
-To use the pelican_nlp package:
+To run pelican_nlp you need a configuration.yml file in your project directory, which specifies the configurations used for your project.
+Sample configuration files can be found on the pelican_nlp github repository: https://github.com/ypauli/pelican_nlp/tree/main/sample_configuration_files
 
-Adapt your configuration file to your needs.
-ALWAYS change the specified project folder location.
+Adapt your configuration file to your needs and save your personal configuration.yml file to your main project directory.
 
-Save configuration file to main project directory.
+Running pelican_nlp with your configurations can be done directly from the command line interface or via Python script.
 
 Run from command line:
 
@@ -93,13 +105,16 @@ Navigate to main project directory in command line and enter the following comma
 
 .. code-block:: bash
 
+    conda activate pelican-nlp
     pelican-run
 
 
 Run with python script:
 
 Create python file with IDE of your choice (e.g. Visual Studio Code, Pycharm, etc.) and copy the following code into the file:
+Make sure to use the previously created conda environment 'pelican-nlp' for your project.
 
+Run the following Python code:
 .. code-block:: python
 
     from pelican_nlp.main import Pelican
@@ -142,8 +157,7 @@ Features
 Examples
 ========
 
-You can find example setups in the [`examples/`](https://github.com/ypauli/pelican_nlp/tree/main/examples) folder.
-ALWAYS change the path to the project folder specified in the configuration file to your specific project location.
+You can find example setups on the github repository in the 'examples` folder: https://github.com/ypauli/pelican_nlp/tree/main/examples
 
 Contributing
 ============

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/README.rst

@@ -19,6 +19,18 @@ pelican_nlp stands for "Preprocessing and Extraction of Linguistic Information f
 Installation
 ============
 
+Create conda environment
+
+.. code-block:: bash
+
+    conda create -n pelican-nlp python=3.10
+
+Activate environment
+
+.. code-block:: bash
+
+    conda activate pelican-nlp
+
 Install the package using pip:
 
 .. code-block:: bash
@@ -34,12 +46,12 @@ For the latest development version:
 Usage
 =====
 
-To use the pelican_nlp package:
+To run pelican_nlp you need a configuration.yml file in your project directory, which specifies the configurations used for your project.
+Sample configuration files can be found on the pelican_nlp github repository: https://github.com/ypauli/pelican_nlp/tree/main/sample_configuration_files
 
-Adapt your configuration file to your needs.
-ALWAYS change the specified project folder location.
+Adapt your configuration file to your needs and save your personal configuration.yml file to your main project directory.
 
-Save configuration file to main project directory.
+Running pelican_nlp with your configurations can be done directly from the command line interface or via Python script.
 
 Run from command line:
 
@@ -47,13 +59,16 @@ Navigate to main project directory in command line and enter the following comma
 
 .. code-block:: bash
 
+    conda activate pelican-nlp
     pelican-run
 
 
 Run with python script:
 
 Create python file with IDE of your choice (e.g. Visual Studio Code, Pycharm, etc.) and copy the following code into the file:
+Make sure to use the previously created conda environment 'pelican-nlp' for your project.
 
+Run the following Python code:
 .. code-block:: python
 
     from pelican_nlp.main import Pelican
@@ -96,8 +111,7 @@ Features
 Examples
 ========
 
-You can find example setups in the [`examples/`](https://github.com/ypauli/pelican_nlp/tree/main/examples) folder.
-ALWAYS change the path to the project folder specified in the configuration file to your specific project location.
+You can find example setups on the github repository in the 'examples` folder: https://github.com/ypauli/pelican_nlp/tree/main/examples
 
 Contributing
 ============

pelican_nlp-0.2.6/pelican_nlp/_version.py

@@ -0,0 +1 @@
+__version__ = "0.2.6"

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/cli.py

@@ -7,6 +7,10 @@ def main():
         print("No .yml configuration file found in the current directory.")
         return
 
+    if len(config_files) > 1:
+        print("More than one configuration file found - remove unneeded files from project directory")
+        return
+
     config_file = config_files[0]  # You could also add logic to choose or validate
     print(f"Using configuration file: {config_file}")
 

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/configuration_files/config_audio.yml

@@ -4,7 +4,6 @@
 # Basic Settings
 # -------------
 input_file: "audio"  # Options: 'text' or 'audio'
-PATH_TO_PROJECT_FOLDER: "/home/yvespauli/PycharmProjects/Silvia"
 language: "dutch"  # Options: 'german', 'english'
 recompute_everything: true  # If false, reuses previously computed results
 output_document_information: true

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/configuration_files/config_discourse.yml

@@ -5,7 +5,6 @@ discourse: &discourse_flag true
 #=====================================
 
 #general configurations; always adapt
-PATH_TO_PROJECT_FOLDER: "/home/yvespauli/PycharmProjects/Morteza/"
 language: "german" # Possibly add options for German and English
 
 task_name: "interview" # Give name of task used for creation of the input file (e.g., ['fluency', 'interview'])

{pelican_nlp-0.2.4/pelican_nlp/sample_configuration_files → pelican_nlp-0.2.6/pelican_nlp/configuration_files}/config_fluency.yml

@@ -5,7 +5,6 @@ fluency_task: &fluency_flag true
 #========================================
 
 #general configurations; always adapt
-PATH_TO_PROJECT_FOLDER: "/path/to/your/project"
 language: "german"
 multiple_sessions: &session_flag false
 

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/configuration_files/config_general.yml

@@ -4,7 +4,6 @@
 # Basic Settings
 # -------------
 input_file: "text"  # Options: 'text' or 'audio'
-PATH_TO_PROJECT_FOLDER: "/home/yvespauli/PycharmProjects/FluencyTest"
 language: "german"  # Options: 'german', 'english'
 recompute_everything: true  # If false, reuses previously computed results
 

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/configuration_files/config_morteza.yml

@@ -3,8 +3,6 @@
 input_file: "text" #or 'audio'
 discourse: &discourse_flag true
 
-#PATH_TO_PROJECT_FOLDER: "/home/yvespauli/PycharmProjects/KetamineStudy/KetamineStudy_ProjectFolder/" # Set default to home directory, e.g., '/home/usr/...'
-PATH_TO_PROJECT_FOLDER: "/home/yvespauli/PycharmProjects/Morteza/"
 language: "german" # Possibly add options for German and English
 
 task_name: "interview" # Give name of task used for creation of the input file (e.g., ['fluency', 'interview'])

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/core/corpus.py

@@ -21,7 +21,7 @@ class Corpus:
         self.documents = documents
         self.config = configuration_settings
         self.project_folder = project_folder
-        self.derivative_dir = project_folder + '/derivatives'
+        self.derivative_dir = project_folder / 'derivatives'
         self.pipeline = TextPreprocessingPipeline(self.config)
         self.task = configuration_settings['task_name']
         self.results_path = None

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/main.py

@@ -24,6 +24,8 @@ from pelican_nlp.core import Corpus
 from pelican_nlp.utils.setup_functions import subject_instantiator, load_config, remove_previous_derivative_dir
 from pelican_nlp.preprocessing import LPDS
 
+project_path = '/home/yvespauli/PycharmProjects/PyPI_testing_fluency/config_fluency.yml'
+
 class Pelican:
 
     """Main class for the Pelican project handling document processing and metric extraction."""
@@ -31,7 +33,7 @@ class Pelican:
     def __init__(self, config_path: str = None, dev_mode: bool = True) -> None:
         self.dev_mode = dev_mode
         
-        # If no config path is provided, use the default config from package
+        # If no config path is provided, use the default config from package; used for dev-mode
         if config_path is None:
             package_dir = Path(__file__).parent
             default_config = package_dir / 'configuration_files' / 'config_fluency.yml'
@@ -205,4 +207,4 @@ class Pelican:
 
 
 if __name__ == '__main__':
-    Pelican().run()
+    Pelican(project_path).run()

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/sample_configuration_files/config_discourse.yml

@@ -5,7 +5,6 @@ discourse: &discourse_flag true
 #=====================================
 
 #general configurations; always adapt
-PATH_TO_PROJECT_FOLDER: "/path/to/your/project"
 language: "german" # Possibly add options for German and English
 
 task_name: "interview" # Give name of task used for creation of the input file (e.g., ['fluency', 'interview'])

{pelican_nlp-0.2.4/pelican_nlp/configuration_files → pelican_nlp-0.2.6/pelican_nlp/sample_configuration_files}/config_fluency.yml

@@ -5,7 +5,6 @@ fluency_task: &fluency_flag true
 #========================================
 
 #general configurations; always adapt
-PATH_TO_PROJECT_FOLDER: "/home/yvespauli/PycharmProjects/FluencyTest"
 language: "german"
 multiple_sessions: &session_flag false
 

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6}/pelican_nlp/sample_configuration_files/config_general.yml

@@ -4,9 +4,8 @@
 # Basic Settings
 # -------------
 input_file: "text"  # Options: 'text' or 'audio'
-PATH_TO_PROJECT_FOLDER: "/path/to/your/project"
 language: "german"
-recompute_everything: true  # If false, reuses previously computed results
+recompute_everything: true #If false will give warning if output folder already exists
 
 # Task Configuration
 # -----------------
@@ -21,7 +20,7 @@ corpus_names:  # List of task corpora
 multiple_sessions: false
 number_of_subjects: null  # If null, auto-detected
 number_of_speakers: 1
-subject_speakertag: null  # Speaker tag for subject (e.g., "B")
+subject_speakertag: null  # Speaker tag for subject (e.g., "B"), only for discourse
 
 # Document Structure
 # ----------------

{pelican_nlp-0.2.4 → pelican_nlp-0.2.6/pelican_nlp.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pelican_nlp
-Version: 0.2.4
+Version: 0.2.6
 Summary: Preprocessing and Extraction of Linguistic Information for Computational Analysis
 Author-email: Yves Pauli <yves.pauli@gmail.com>
 License-Expression: CC-BY-NC-4.0
@@ -65,6 +65,18 @@ pelican_nlp stands for "Preprocessing and Extraction of Linguistic Information f
 Installation
 ============
 
+Create conda environment
+
+.. code-block:: bash
+
+    conda create -n pelican-nlp python=3.10
+
+Activate environment
+
+.. code-block:: bash
+
+    conda activate pelican-nlp
+
 Install the package using pip:
 
 .. code-block:: bash
@@ -80,12 +92,12 @@ For the latest development version:
 Usage
 =====
 
-To use the pelican_nlp package:
+To run pelican_nlp you need a configuration.yml file in your project directory, which specifies the configurations used for your project.
+Sample configuration files can be found on the pelican_nlp github repository: https://github.com/ypauli/pelican_nlp/tree/main/sample_configuration_files
 
-Adapt your configuration file to your needs.
-ALWAYS change the specified project folder location.
+Adapt your configuration file to your needs and save your personal configuration.yml file to your main project directory.
 
-Save configuration file to main project directory.
+Running pelican_nlp with your configurations can be done directly from the command line interface or via Python script.
 
 Run from command line:
 
@@ -93,13 +105,16 @@ Navigate to main project directory in command line and enter the following comma
 
 .. code-block:: bash
 
+    conda activate pelican-nlp
     pelican-run
 
 
 Run with python script:
 
 Create python file with IDE of your choice (e.g. Visual Studio Code, Pycharm, etc.) and copy the following code into the file:
+Make sure to use the previously created conda environment 'pelican-nlp' for your project.
 
+Run the following Python code:
 .. code-block:: python
 
     from pelican_nlp.main import Pelican
@@ -142,8 +157,7 @@ Features
 Examples
 ========
 
-You can find example setups in the [`examples/`](https://github.com/ypauli/pelican_nlp/tree/main/examples) folder.
-ALWAYS change the path to the project folder specified in the configuration file to your specific project location.
+You can find example setups on the github repository in the 'examples` folder: https://github.com/ypauli/pelican_nlp/tree/main/examples
 
 Contributing
 ============

pelican_nlp-0.2.4/pelican_nlp/_version.py

@@ -1 +0,0 @@
-__version__ = "0.2.4"