pelican-nlp 0.1.3__tar.gz → 0.2.1__tar.gz

{pelican_nlp-0.1.3/pelican_nlp.egg-info → pelican_nlp-0.2.1}/PKG-INFO

@@ -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 → pelican_nlp-0.2.1}/README.rst

@@ -39,14 +39,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:
@@ -79,7 +96,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.2.1/pelican_nlp/_version.py

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

pelican_nlp-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-0.1.3 → pelican_nlp-0.2.1}/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 → pelican_nlp-0.2.1/pelican_nlp.egg-info}/PKG-INFO

@@ -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 → pelican_nlp-0.2.1}/pelican_nlp.egg-info/SOURCES.txt

@@ -21,10 +21,12 @@ examples/PyPI_testing_image-descriptions/subjects/sub-02/ses-01/image-descriptio
 examples/PyPI_testing_image-descriptions/subjects/sub-02/ses-01/image-description/sub-02_ses-01_image-description_placebo.docx
 pelican_nlp/__init__.py
 pelican_nlp/_version.py
+pelican_nlp/cli.py
 pelican_nlp/main.py
 pelican_nlp.egg-info/PKG-INFO
 pelican_nlp.egg-info/SOURCES.txt
 pelican_nlp.egg-info/dependency_links.txt
+pelican_nlp.egg-info/entry_points.txt
 pelican_nlp.egg-info/requires.txt
 pelican_nlp.egg-info/top_level.txt
 pelican_nlp/Nils_backup/__init__.py

pelican_nlp-0.2.1/pelican_nlp.egg-info/entry_points.txt

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

{pelican_nlp-0.1.3 → pelican_nlp-0.2.1}/pyproject.toml

@@ -54,6 +54,9 @@ Repository = "https://github.com/ypauli/pelican_nlp"
 Documentation = "https://github.com/ypauli/pelican_nlp#readme"
 "Bug Tracker" = "https://github.com/ypauli/pelican_nlp/issues"
 
+[project.scripts]
+pelican-run = "pelican_nlp.cli:main"
+
 [tool.setuptools]
 packages = ["pelican_nlp"]
 include-package-data = true
@@ -61,6 +64,9 @@ include-package-data = true
 [tool.setuptools.package-dir]
 pelican_nlp = "pelican_nlp"
 
+[tool.poetry.dependencies]
+python = "3.10"
+
 [options]
 zip_safe = false
 

pelican_nlp-0.1.3/pelican_nlp/_version.py

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