<div id="top"></div>

<!-- PROJECT LOGO -->

<div align="center">
<h3 align="center">
    Develop a package to convert video to mp3
</h3>
</div>

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li><a href="#about-the-project">About The Project</a></li>
    <li><a href="#built-with">Built With</a></li>
    <li><a href="#installation">Installation</a></li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#tests">Tests</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

<div id="about-the-project"></div>

Welcome to the documentation of video_to_mp3, a Python package that simplifies the conversion of videos to audio files. This versatile tool is designed to be used both as a library in your Python scripts and via the command line for quick and easy usage.

<p align="right">(<a href="#top">back to top</a>)</p>

### Built With

<div id="built-with"></div>

- [Python 3.10+](https://www.python.org/)
- [moviepy==1.0.3](https://pypi.org/project/moviepy/)
- [click](https://pypi.org/project/click/)

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- INSTALLATION -->

## Installation

1. <a href="#video_to_mp3-installation">Install video_to_mp3</a>
   ```sh
   pip install video_to_mp3
   ```

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->

## Usage

### Usage as a Python library

```sh
    from video_to_mp3 import video_to_mp3

    # Specify the input and output paths.
    video_path = "path/to/your/video_file.mp4"
    audio_path = "path/to/your/output/audio_audio" # Optional

    # Call function to conversion
    video_to_mp3.convert(video_path, audio_path)
```

### Command Line Usage

After installation, you can use video_to_mp3 directly in your terminal

```sh
    video_to_mp3 --input=path/to/your_video.mp4 --output=path/to/output/your_audio

```

Available command line options:

- --input: Path to the input video.
- --output: Path to the output audio file."

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- TESTS -->

## GitHub Repository

Find the source code, contribute, and stay updated on <a href="https://github.com/joelproxi/python-converter"> GitHub.</a>"

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE` for more information.

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- CONTACT -->

## Contributions

Contributions are welcome! Feel free to open an issue to report problems or submit a pull request with improvements.

### Acknowledgments

Thank you for using video_to_mp3! If you have any questions or suggestions, please feel free to share them on GitHub.

## contact

Joel Edmond Nguemeta👇🏻 <br>
Email : joeledmond95@yahoo.com <br>
LinkedIn : https://www.linkedin.com/in/joelproxi/

<p align="right">(<a href="#top">back to top</a>)</p>
