flac2mp3-cli


Nameflac2mp3-cli JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/rimaout/flac2mp3
SummaryA Python CLI tool to convert FLAC to MP3
upload_time2024-03-01 15:26:26
maintainer
docs_urlNone
authormariout
requires_python
licenseMIT
keywords python audio coverter flac mp3 multithreading
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # flac2mp3

Python-based CLI audio format converter specifically designed for FLAC to MP3 conversions.


### Install Package
```shell
pip install flac2mp3-cli
```

# Description

This program is a multi-threaded FLAC to MP3 converter. It can convert a single FLAC file, or it can convert multiple FLAC files in a directory. Non-FLAC files in the directory are copied without conversion. The metadata of the original FLAC files is maintained in the converted MP3 files.

## Usage

To run the program, use the following command:

```shell
flac2mp3 <input_path> [<thread_count>] [<output_path>]
```

**Where:**

- `<input_path>` is the path to the FLAC file or directory of FLAC files to convert.
- `<thread_count>` (optional) is the number of threads to use for conversion. If not provided, the program will use a default value.
- `<output_path>` (optional) is the path to the directory where the converted MP3 files (and copied non-FLAC files) should be saved. If not provided, the program will save the files in a default directory.

### Converting a Single File

To convert a single FLAC file, provide the path to the file as the `<input_path>`:

```shell
flac2mp3 /path/to/your/file.flac
```

### Converting a Directory

To convert all FLAC files in a directory, provide the path to the directory as the `<input_path>`:

```shell
flac2mp3 /path/to/your/directory
```

All FLAC files in the directory (and its subdirectories) will be converted to MP3.

## Dependencies

This program uses the following Python packages:

- `alive_progress` for progress bars
- `concurrent.futures` for multi-threading
- `os` and `shutil` for file and directory operations
- `sys` and `time` for system operations

## Build Yourself
If you want to build this project yourself, follow these steps:

1. **Clone the repository**

   Clone the repository to your local machine:

   ```shell
   git clone https://github.com/yourusername/flac-to-mp3-converter.git
   ```
2. **Install the project**

   Navigate into the project directory and install the project along with its dependencies:

   ```shell
   cd flac-to-mp3-converter
   pip install
   ```


## License

This program is released under the MIT License. See the `LICENSE` file for more details.

## About
This project was born out of a personal need. I needed a tool that could convert my extensive library of FLAC files to MP3 format all at once. This would allow me to enjoy my music collection on devices that don't support FLAC.

This is one of my first projects and I'm still learning, so feel free to correct me or suggest improvements, raise issues or contribute to the project!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rimaout/flac2mp3",
    "name": "flac2mp3-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python,audio coverter,flac,mp3,multithreading",
    "author": "mariout",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/3b/91/656006788a08e39cf557f4092c8f75e94c8194353cd09221b130359f6bce/flac2mp3-cli-1.1.0.tar.gz",
    "platform": null,
    "description": "# flac2mp3\n\nPython-based CLI audio format converter specifically designed for FLAC to MP3 conversions.\n\n\n### Install Package\n```shell\npip install flac2mp3-cli\n```\n\n# Description\n\nThis program is a multi-threaded FLAC to MP3 converter. It can convert a single FLAC file, or it can convert multiple FLAC files in a directory. Non-FLAC files in the directory are copied without conversion. The metadata of the original FLAC files is maintained in the converted MP3 files.\n\n## Usage\n\nTo run the program, use the following command:\n\n```shell\nflac2mp3 <input_path> [<thread_count>] [<output_path>]\n```\n\n**Where:**\n\n- `<input_path>` is the path to the FLAC file or directory of FLAC files to convert.\n- `<thread_count>` (optional) is the number of threads to use for conversion. If not provided, the program will use a default value.\n- `<output_path>` (optional) is the path to the directory where the converted MP3 files (and copied non-FLAC files) should be saved. If not provided, the program will save the files in a default directory.\n\n### Converting a Single File\n\nTo convert a single FLAC file, provide the path to the file as the `<input_path>`:\n\n```shell\nflac2mp3 /path/to/your/file.flac\n```\n\n### Converting a Directory\n\nTo convert all FLAC files in a directory, provide the path to the directory as the `<input_path>`:\n\n```shell\nflac2mp3 /path/to/your/directory\n```\n\nAll FLAC files in the directory (and its subdirectories) will be converted to MP3.\n\n## Dependencies\n\nThis program uses the following Python packages:\n\n- `alive_progress` for progress bars\n- `concurrent.futures` for multi-threading\n- `os` and `shutil` for file and directory operations\n- `sys` and `time` for system operations\n\n## Build Yourself\nIf you want to build this project yourself, follow these steps:\n\n1. **Clone the repository**\n\n   Clone the repository to your local machine:\n\n   ```shell\n   git clone https://github.com/yourusername/flac-to-mp3-converter.git\n   ```\n2. **Install the project**\n\n   Navigate into the project directory and install the project along with its dependencies:\n\n   ```shell\n   cd flac-to-mp3-converter\n   pip install\n   ```\n\n\n## License\n\nThis program is released under the MIT License. See the `LICENSE` file for more details.\n\n## About\nThis project was born out of a personal need. I needed a tool that could convert my extensive library of FLAC files to MP3 format all at once. This would allow me to enjoy my music collection on devices that don't support FLAC.\n\nThis is one of my first projects and I'm still learning, so feel free to correct me or suggest improvements, raise issues or contribute to the project!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python CLI tool to convert FLAC to MP3",
    "version": "1.1.0",
    "project_urls": {
        "Homepage": "https://github.com/rimaout/flac2mp3"
    },
    "split_keywords": [
        "python",
        "audio coverter",
        "flac",
        "mp3",
        "multithreading"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "678862ebf31a0f1b23e7617ad53717cd4912e6f1820cd4124805395ca422c55c",
                "md5": "fff37091ca8b3885ed18334f0348c6e0",
                "sha256": "03c05432b9ef59213e9413693ea3d724a83e53f7bad8e79f2c5c1b6eee7cc5e5"
            },
            "downloads": -1,
            "filename": "flac2mp3_cli-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fff37091ca8b3885ed18334f0348c6e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6439,
            "upload_time": "2024-03-01T15:26:24",
            "upload_time_iso_8601": "2024-03-01T15:26:24.028581Z",
            "url": "https://files.pythonhosted.org/packages/67/88/62ebf31a0f1b23e7617ad53717cd4912e6f1820cd4124805395ca422c55c/flac2mp3_cli-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b91656006788a08e39cf557f4092c8f75e94c8194353cd09221b130359f6bce",
                "md5": "4776ac8b0192949f831834f8735deb75",
                "sha256": "79f46afa753d2ef2f74a81e14cc262352a82d7e8138493453230834ce8315442"
            },
            "downloads": -1,
            "filename": "flac2mp3-cli-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4776ac8b0192949f831834f8735deb75",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5813,
            "upload_time": "2024-03-01T15:26:26",
            "upload_time_iso_8601": "2024-03-01T15:26:26.012775Z",
            "url": "https://files.pythonhosted.org/packages/3b/91/656006788a08e39cf557f4092c8f75e94c8194353cd09221b130359f6bce/flac2mp3-cli-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-01 15:26:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rimaout",
    "github_project": "flac2mp3",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "flac2mp3-cli"
}
        
Elapsed time: 0.28556s