gpac_autocompletion

This repository contains a Python-based autocompletion script for gpac commands. The project is structured to include the main autocompletion logic and unit tests to ensure the functionality.

For more information about gpac, visit the gpac repository.

Project Structure

Directories and Files

• autocomplete/: Contains the main autocompletion scripts.
  • gpac_autocomplete.py: The primary script for gpac autocompletion.
• unittests/: Contains unit tests for the autocompletion scripts.
• bash_gpac_autocomplete.sh: Shell script to enable gpac autocompletion.
• README.md: This file, providing an overview of the project.

Installation

Before you begin, ensure you have Python 3 installed on your system. You can check your Python version with:

python3 --version

1. Clone the repository:

git clone https://github.com/touatily/gpac_autocompletion.git
cd gpac_autocompletion

2. Install: To install the script for the current user, run:

./install.sh

Alternatively, to install it system-wide for all users, use:

sudo ./install.sh

3. After installation, apply the changes by running:

source ~/.bashrc

Alternatively, you can open a new terminal to apply the changes.

Updating

To update the autocompletion script to the latest version, follow these steps:

1. Navigate to the project directory:

cd /path/to/gpac_autocompletion

2. Pull the latest changes from the repository:

git pull

3. Reinstall the script:

./install.sh

If you installed it system-wide, use:

sudo ./install.sh

4. Apply the changes by running:

source ~/.bashrc

Alternatively, you can open a new terminal to apply the changes.

Running Tests

To run the unit tests, use the following command:

./run_unittests.sh

Contributing

• Fork the repository.
• Create a new branch (git checkout -b feature-branch).
• Make your changes.
• Run the unit tests (./run_unittests.sh) to ensure everything works.
• Commit your changes (git commit -am 'Add new feature').
• Push to the branch (git push origin feature-branch).
• Create a new Pull Request.