pelican-nlp 0.1.3__py3-none-any.whl → 0.2.1__py3-none-any.whl

pelican_nlp/_version.py

@@ -1 +1 @@
-__version__ = "0.1.3"
+__version__ = "0.2.1"

pelican_nlp/cli.py

@@ -0,0 +1,14 @@
+import os
+from pelican_nlp.main import Pelican
+
+def main():
+    config_files = [f for f in os.listdir(".") if f.endswith(".yml")]
+    if not config_files:
+        print("No .yml configuration file found in the current directory.")
+        return
+
+    config_file = config_files[0]  # You could also add logic to choose or validate
+    print(f"Using configuration file: {config_file}")
+
+    pelican = Pelican(config_file)
+    pelican.run()

pelican_nlp/main.py

@@ -24,9 +24,6 @@ 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
 
-# Constants
-# DEFAULT_CONFIG_PATH = 'configuration_files/config_morteza.yml'
-
 class Pelican:
 
     """Main class for the Pelican project handling document processing and metric extraction."""
@@ -47,9 +44,9 @@ class Pelican:
         # Verify the provided path is a YAML file
         elif not config_path.endswith(('.yml', '.yaml')):
             sys.exit('Error: Configuration file must be a YAML file (*.yml or *.yaml)')
-        
+
         self.config = load_config(config_path)
-        self.project_path = Path(self.config['PATH_TO_PROJECT_FOLDER'])
+        self.project_path = Path(config_path).resolve().parent
         self.path_to_subjects = self.project_path / 'subjects'
         self.output_directory = self.project_path / 'derivatives'
         self.task = self.config['task_name']

{pelican_nlp-0.1.3.dist-info → pelican_nlp-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pelican_nlp
-Version: 0.1.3
+Version: 0.2.1
 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
@@ -85,14 +85,31 @@ To use the pelican_nlp package:
 Adapt your configuration file to your needs.
 ALWAYS change the specified project folder location.
 
+Save configuration file to main project directory.
+
+Run from command line:
+
+Navigate to main project directory in command line and enter the following command (Note: Folder must contain your subjects folder and your configuration.yml file):
+
+.. code-block:: bash
+
+    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:
+
 .. code-block:: python
 
     from pelican_nlp.main import Pelican
 
-    configuration_file = "/path/to/your/config/file"
+    configuration_file = "/path/to/your/config/file.yml"
     pelican = Pelican(configuration_file)
     pelican.run()
 
+Replace "/path/to/your/config/file" with the path to your configuration file located in your main project folder.
+
 For reliable operation, data must be stored in the *Language Processing Data Structure (LPDS)* format, inspired by brain imaging data structure conventions.
 
 Text and audio files should follow this naming convention:
@@ -125,7 +142,7 @@ Features
 Examples
 ========
 
-You can find example setups in the [`examples/`](https://github.com/ypauli/pelican_nlp/examples) folder.
+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.
 
 Contributing

{pelican_nlp-0.1.3.dist-info → pelican_nlp-0.2.1.dist-info}/RECORD

@@ -1,6 +1,7 @@
 pelican_nlp/__init__.py,sha256=TD5xjKeXXAH6nUWG-6igbClgovi5r8RIEqI_ix1QeYo,204
-pelican_nlp/_version.py,sha256=R5TtpJu7Qu6sOarfDpp-5Oyy8Pi2Ir3VewCvsCQiAgo,21
-pelican_nlp/main.py,sha256=xKUqqA3sh9kbk07lKA_poILIU1c8oIeaSsVqPOPY5Tk,7596
+pelican_nlp/_version.py,sha256=tC9CwL4Nm8brVXJnZNGk_eoZaJj6eOtLKtOrdJMrpoI,21
+pelican_nlp/cli.py,sha256=uXouL67mTjBynFMWpBTaGvGtEBWDnbS1BI7aRdxV-0M,439
+pelican_nlp/main.py,sha256=WKiDHXVFKtkD6AkTZSGlT824hKbpp5PAu2-HlcKsi-Q,7501
 pelican_nlp/Nils_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pelican_nlp/Nils_backup/extract_acoustic_features.py,sha256=eSP8lXxbZ15YE1HqxGtma9uWOcSN-fI-ig-NwQ9eOA8,10771
 pelican_nlp/Nils_backup/speaker_diarization_Nils.py,sha256=3RIhjKihu4Z1rruMt9KESFE2lqesfzIpRr7rLummUEo,10219
@@ -68,8 +69,9 @@ pelican_nlp/utils/__init__.py,sha256=q1tGdOOj5UPRC2mGhoMUh8p4cbFCkkbD21bQaOVvFao
 pelican_nlp/utils/csv_functions.py,sha256=hsG73gm3Up9sAerp6gIxuNHaeP1vJj6HSh7ggVm1SSo,7272
 pelican_nlp/utils/sample_usage.py,sha256=W__OVMjWND-ZtxxRhfGJDHwbVpGlB-anXDxyA5P4cME,353
 pelican_nlp/utils/setup_functions.py,sha256=s0QcarswU8qeFBcEQNIYC1ooaD-xwRiTJn--yPEId8E,3612
-pelican_nlp-0.1.3.dist-info/licenses/LICENSE,sha256=m3jshBZIXKiBX6qhmhtJcLTVJ1N6BEkQGIflneXvpYg,19336
-pelican_nlp-0.1.3.dist-info/METADATA,sha256=U_PWoZdXS5KVZUXUokNZBWQikMj-8VfOKyh-6nscySE,4998
-pelican_nlp-0.1.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pelican_nlp-0.1.3.dist-info/top_level.txt,sha256=F0qlyqy5FCd3sTS_npUYPeLKN9_BZq6wD4qo9pI0xbg,12
-pelican_nlp-0.1.3.dist-info/RECORD,,
+pelican_nlp-0.2.1.dist-info/licenses/LICENSE,sha256=m3jshBZIXKiBX6qhmhtJcLTVJ1N6BEkQGIflneXvpYg,19336
+pelican_nlp-0.2.1.dist-info/METADATA,sha256=VvSKygkPyQ_RzTM9-HvKRdP-m0TtQThAC8pLoJJPikE,5562
+pelican_nlp-0.2.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pelican_nlp-0.2.1.dist-info/entry_points.txt,sha256=znlG0paAfju9P10UM3rm5HcCHoj4tarTllNpeaqH_gc,53
+pelican_nlp-0.2.1.dist-info/top_level.txt,sha256=F0qlyqy5FCd3sTS_npUYPeLKN9_BZq6wD4qo9pI0xbg,12
+pelican_nlp-0.2.1.dist-info/RECORD,,

pelican_nlp-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pelican-run = pelican_nlp.cli:main