pelican-nlp 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

pelican_nlp/_version.py

@@ -1 +1 @@
-__version__ = "0.1.2"
+__version__ = "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.dist-info → pelican_nlp-0.2.0.dist-info}/METADATA

@@ -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.dist-info → pelican_nlp-0.2.0.dist-info}/RECORD

@@ -1,5 +1,6 @@
 pelican_nlp/__init__.py,sha256=TD5xjKeXXAH6nUWG-6igbClgovi5r8RIEqI_ix1QeYo,204
-pelican_nlp/_version.py,sha256=K5SiDdEGYMpdqXThrqwTqECJJBOQNTQDrnpc2K5mzKs,21
+pelican_nlp/_version.py,sha256=1KhrBItVjTCR-Sumh0o09b_aKrjTTcJrpTBh5GBw6Lk,21
+pelican_nlp/cli.py,sha256=uXouL67mTjBynFMWpBTaGvGtEBWDnbS1BI7aRdxV-0M,439
 pelican_nlp/main.py,sha256=xKUqqA3sh9kbk07lKA_poILIU1c8oIeaSsVqPOPY5Tk,7596
 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
@@ -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.2.dist-info/licenses/LICENSE,sha256=m3jshBZIXKiBX6qhmhtJcLTVJ1N6BEkQGIflneXvpYg,19336
-pelican_nlp-0.1.2.dist-info/METADATA,sha256=Iuz8Y4HbCCFdcCYvXlGjANQBGd9Zf1Ez6tjD9nnVLuw,5001
-pelican_nlp-0.1.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pelican_nlp-0.1.2.dist-info/top_level.txt,sha256=F0qlyqy5FCd3sTS_npUYPeLKN9_BZq6wD4qo9pI0xbg,12
-pelican_nlp-0.1.2.dist-info/RECORD,,
+pelican_nlp-0.2.0.dist-info/licenses/LICENSE,sha256=m3jshBZIXKiBX6qhmhtJcLTVJ1N6BEkQGIflneXvpYg,19336
+pelican_nlp-0.2.0.dist-info/METADATA,sha256=cPHyXYc9hkl9h_--O52dmLWkMFvDxK2ncEhg7Xl01kc,5562
+pelican_nlp-0.2.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+pelican_nlp-0.2.0.dist-info/entry_points.txt,sha256=znlG0paAfju9P10UM3rm5HcCHoj4tarTllNpeaqH_gc,53
+pelican_nlp-0.2.0.dist-info/top_level.txt,sha256=F0qlyqy5FCd3sTS_npUYPeLKN9_BZq6wD4qo9pI0xbg,12
+pelican_nlp-0.2.0.dist-info/RECORD,,

pelican_nlp-0.2.0.dist-info/entry_points.txt

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