README.md and requirements.txt

BIDSHandler/MainApplication.py

 import tkinter as tk
+import webbrowser
 
 import BIDSHandler.CreationTool.Application as CreationTool
 import BIDSHandler.ViewingTool.Application as ViewingTool
@@ -63,5 +64,4 @@ class Application(tk.Frame):
     def validate_bids(self):
         ''' This method is used to open a web browser at https://bids-standard.github.io/bids-validator/ to validate a BIDS project.
         '''
-        import webbrowser
         webbrowser.open('https://bids-standard.github.io/bids-validator/')
\ No newline at end of file

BIDSHandler/Tools.py

@@ -16,7 +16,6 @@ import os
 from re import search
 
 
-
 def get_entities_single_file(file):
     ''' This method is used to get the entities of a file.
 

test/CreationApplicationTestCase.py → BIDSHandler/tests/CreationApplicationTestCase.py

@@ -67,17 +67,6 @@ class MyTestCase(unittest.TestCase):
         shared_entities = Tools.find_shared_entities(files_entities)
         self.assertEqual('sub-01_task-rest_', shared_entities)
 
-    def test_get_dict_from_path(self):
-        # Test the get_dict_from_path method of the Application class.
-
-        path = 'D:/Fichiers_Abdallah/res/test_creation/bozo'
-
-        files = [
-            'D:/Fichiers_Abdallah/res/test_creation/bozo/sub-01/ses-2/eeg/sub-01_ses-2_task-bonjour_run-01_eeg.edf',
-            'D:/Fichiers_Abdallah/res/test_creation/bozo/sub-03/ses-1/eeg/sub-03_ses-1_task-travail_run-02_eeg.edf']
-
-        dictionary = Tools.get_dict_from_path(path)
-        print(dictionary)
 
 
 if __name__ == '__main__':

README.md

+# BIDS Handler
+
+This project is a Python application that handles Brain Imaging Data Structure (BIDS) datasets. It provides tools for creating, viewing, and validating BIDS datasets.
+
+## Features
+
+- **Viewing Tool**: Allows you to view the structure and content of a BIDS dataset. (Currently only displays edf files)
+- **Creation Tool**: Helps you to create a new BIDS dataset or modify an existing one. (Currently only creates eeg datasets)
+- **BIDS Validator**: Opens a web browser at the BIDS Validator website to validate a BIDS project.
+
+## Installation
+
+This project requires Python 3.7 or later. You can download Python from [here](https://www.python.org/downloads/).
+
+After installing Python, you can clone this repository to your local machine using the following command:
+
+```bash
+git clone https://gitlab.cristal.univ-lille.fr/atoumji/python-project-start.git
+```
+
+Then, navigate to the project directory:
+
+```bash
+cd BIDSHandler
+```
+
+
+
+## Required Python Modules
+
+The required Python modules are listed in the `requirements.txt` file. You can install them using the following command:
+
+```bash
+pip install -r requirements.txt
+```
+
+
+## Usage
+
+To run the application, navigate to the project directory and run the `MainApplication.py` script:
+
+```bash
+cd BIDSHandler
+python main.py
+```
+
+### Creation tool
+To use the creation tool, you will need to have edf experiment files ready.
+You can also have sidecar already created for the edf files, if not the tool will help you create them.
+
+The creation tool follow 4 steps:
+1. Select the name of the dataset, the root directory and the base files you want to create.
+2. Create the dataset and the base files.
+3. Integrate the edf files into the dataset.
+4. Integrate or create the sidecar files for the edf files.
+
+### Viewing tool
+To use the viewing tool, you will need to have a BIDS dataset ready.
+The viewing tool will display the content of the dataset in a tree view at the left of the window.
+You can select a file to display its content in the right part of the window.
+
+### BIDS Validator
+To use the BIDS Validator, you will need to have a BIDS dataset ready.
+The BIDS Validator will open a web browser at the BIDS Validator website.
+You will need to upload your dataset to the website to validate it.
+The BIDS Validator will check if your dataset is compliant with the BIDS standard and will display the results in the web browser.
+
+## Contributing
+
+TODO
+## License
+
+TODO
\ No newline at end of file