pelican-nlp 0.1.2__tar.gz → 0.2.0__tar.gz

{pelican_nlp-0.1.2/pelican_nlp.egg-info → pelican_nlp-0.2.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: pelican_nlp
-Version: 0.1.2
+Version: 0.2.0
 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
-Project-URL: Homepage, https://github.com/ypauli/PELICAN_nlp
-Project-URL: Repository, https://github.com/ypauli/PELICAN_nlp
-Project-URL: Documentation, https://github.com/ypauli/PELICAN_nlp#readme
-Project-URL: Bug Tracker, https://github.com/ypauli/PELICAN_nlp/issues
+Project-URL: Homepage, https://github.com/ypauli/pelican_nlp
+Project-URL: Repository, https://github.com/ypauli/pelican_nlp
+Project-URL: Documentation, https://github.com/ypauli/pelican_nlp#readme
+Project-URL: Bug Tracker, https://github.com/ypauli/pelican_nlp/issues
 Keywords: nlp,linguistics,preprocessing,language-processing,text-analysis
 Classifier: Development Status :: 1 - Planning
 Classifier: Intended Audience :: Science/Research
@@ -48,18 +48,18 @@ Dynamic: license-file
 PELICAN_nlp
 ====================================
 
-PELICAN_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
+pelican_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
 
 .. image:: https://img.shields.io/pypi/v/package-name.svg
-    :target: https://pypi.org/project/pelican-nlp/
+    :target: https://pypi.org/project/pelican_nlp/
     :alt: PyPI version
 
 .. image:: https://img.shields.io/github/license/username/package-name.svg
-    :target: https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE
+    :target: https://github.com/ypauli/pelican_nlp/blob/main/LICENSE
     :alt: License
 
 .. image:: https://img.shields.io/pypi/pyversions/package-name.svg
-    :target: https://pypi.org/project/pelican-nlp/
+    :target: https://pypi.org/project/pelican_nlp/
     :alt: Supported Python Versions
 
 Installation
@@ -75,7 +75,7 @@ For the latest development version:
 
 .. code-block:: bash
 
-    pip install https://github.com/yourusername/yourrepo/releases/tag/v0.1.0-alpha
+    pip install https://github.com/ypauli/pelican_nlp/releases/tag/v0.1.2-alpha
 
 Usage
 =====
@@ -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,15 +142,15 @@ 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
 ============
 
-Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/PELICAN-nlp/blob/main/CONTRIBUTING.md>`_.
+Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/pelican_nlp/blob/main/CONTRIBUTING.md>`_.
 
 License
 =======
 
-This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE>`_ file for details.
+This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/pelican_nlp/blob/main/LICENSE>`_ file for details.

{pelican_nlp-0.1.2 → pelican_nlp-0.2.0}/README.rst

@@ -2,18 +2,18 @@
 PELICAN_nlp
 ====================================
 
-PELICAN_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
+pelican_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
 
 .. image:: https://img.shields.io/pypi/v/package-name.svg
-    :target: https://pypi.org/project/pelican-nlp/
+    :target: https://pypi.org/project/pelican_nlp/
     :alt: PyPI version
 
 .. image:: https://img.shields.io/github/license/username/package-name.svg
-    :target: https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE
+    :target: https://github.com/ypauli/pelican_nlp/blob/main/LICENSE
     :alt: License
 
 .. image:: https://img.shields.io/pypi/pyversions/package-name.svg
-    :target: https://pypi.org/project/pelican-nlp/
+    :target: https://pypi.org/project/pelican_nlp/
     :alt: Supported Python Versions
 
 Installation
@@ -29,7 +29,7 @@ For the latest development version:
 
 .. code-block:: bash
 
-    pip install https://github.com/yourusername/yourrepo/releases/tag/v0.1.0-alpha
+    pip install https://github.com/ypauli/pelican_nlp/releases/tag/v0.1.2-alpha
 
 Usage
 =====
@@ -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,15 +96,15 @@ 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
 ============
 
-Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/PELICAN-nlp/blob/main/CONTRIBUTING.md>`_.
+Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/pelican_nlp/blob/main/CONTRIBUTING.md>`_.
 
 License
 =======
 
-This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE>`_ file for details.
+This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/pelican_nlp/blob/main/LICENSE>`_ file for details.

pelican_nlp-0.2.0/pelican_nlp/_version.py

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

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

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: pelican_nlp
-Version: 0.1.2
+Version: 0.2.0
 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
-Project-URL: Homepage, https://github.com/ypauli/PELICAN_nlp
-Project-URL: Repository, https://github.com/ypauli/PELICAN_nlp
-Project-URL: Documentation, https://github.com/ypauli/PELICAN_nlp#readme
-Project-URL: Bug Tracker, https://github.com/ypauli/PELICAN_nlp/issues
+Project-URL: Homepage, https://github.com/ypauli/pelican_nlp
+Project-URL: Repository, https://github.com/ypauli/pelican_nlp
+Project-URL: Documentation, https://github.com/ypauli/pelican_nlp#readme
+Project-URL: Bug Tracker, https://github.com/ypauli/pelican_nlp/issues
 Keywords: nlp,linguistics,preprocessing,language-processing,text-analysis
 Classifier: Development Status :: 1 - Planning
 Classifier: Intended Audience :: Science/Research
@@ -48,18 +48,18 @@ Dynamic: license-file
 PELICAN_nlp
 ====================================
 
-PELICAN_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
+pelican_nlp stands for "Preprocessing and Extraction of Linguistic Information for Computational Analysis - Natural Language Processing". This package enables the creation of standardized and reproducible language processing pipelines, extracting linguistic features from various tasks like discourse, fluency, and image descriptions.
 
 .. image:: https://img.shields.io/pypi/v/package-name.svg
-    :target: https://pypi.org/project/pelican-nlp/
+    :target: https://pypi.org/project/pelican_nlp/
     :alt: PyPI version
 
 .. image:: https://img.shields.io/github/license/username/package-name.svg
-    :target: https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE
+    :target: https://github.com/ypauli/pelican_nlp/blob/main/LICENSE
     :alt: License
 
 .. image:: https://img.shields.io/pypi/pyversions/package-name.svg
-    :target: https://pypi.org/project/pelican-nlp/
+    :target: https://pypi.org/project/pelican_nlp/
     :alt: Supported Python Versions
 
 Installation
@@ -75,7 +75,7 @@ For the latest development version:
 
 .. code-block:: bash
 
-    pip install https://github.com/yourusername/yourrepo/releases/tag/v0.1.0-alpha
+    pip install https://github.com/ypauli/pelican_nlp/releases/tag/v0.1.2-alpha
 
 Usage
 =====
@@ -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,15 +142,15 @@ 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
 ============
 
-Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/PELICAN-nlp/blob/main/CONTRIBUTING.md>`_.
+Contributions are welcome! Please check out the `contributing guide <https://github.com/ypauli/pelican_nlp/blob/main/CONTRIBUTING.md>`_.
 
 License
 =======
 
-This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/PELICAN-nlp/blob/main/LICENSE>`_ file for details.
+This project is licensed under Attribution-NonCommercial 4.0 International. See the `LICENSE <https://github.com/ypauli/pelican_nlp/blob/main/LICENSE>`_ file for details.

{pelican_nlp-0.1.2 → pelican_nlp-0.2.0}/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.0/pelican_nlp.egg-info/entry_points.txt

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

{pelican_nlp-0.1.2 → pelican_nlp-0.2.0}/pyproject.toml

@@ -49,10 +49,13 @@ dependencies = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/ypauli/PELICAN_nlp"
-Repository = "https://github.com/ypauli/PELICAN_nlp"
-Documentation = "https://github.com/ypauli/PELICAN_nlp#readme"
-"Bug Tracker" = "https://github.com/ypauli/PELICAN_nlp/issues"
+Homepage = "https://github.com/ypauli/pelican_nlp"
+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"]
@@ -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.2/pelican_nlp/_version.py

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