-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
26700c2
commit 26a8ec9
Showing
1 changed file
with
87 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,88 @@ | ||
# weird-converter | ||
# Weird converter | ||
|
||
[![PyPI version](https://badge.fury.io/py/weird-converter.svg)](https://pypi.org/project/weird-converter/) | ||
[![Downloads](https://pepy.tech/badge/weird-converter)](https://pepy.tech/project/weird-converter) | ||
[![Downloads](https://pepy.tech/badge/weird-converter/month)](https://pepy.tech/project/weird-converter/month) | ||
[![Downloads](https://pepy.tech/badge/weird-converter/week)](https://pepy.tech/project/weird-converter/week) | ||
<br> | ||
[![HitCount](http://hits.dwyl.io/AlbertSuarez/weird-converter.svg)](http://hits.dwyl.io/AlbertSuarez/weird-converter) | ||
![Python package](https://github.com/AlbertSuarez/weird-converter/workflows/Python%20package/badge.svg) | ||
[![GitHub stars](https://img.shields.io/github/stars/AlbertSuarez/weird-converter.svg)](https://GitHub.com/AlbertSuarez/weird-converter/stargazers/) | ||
[![GitHub forks](https://img.shields.io/github/forks/AlbertSuarez/weird-converter.svg)](https://GitHub.com/AlbertSuarez/weird-converter/network/) | ||
[![GitHub contributors](https://img.shields.io/github/contributors/AlbertSuarez/weird-converter.svg)](https://GitHub.com/AlbertSuarez/weird-converter/graphs/contributors/) | ||
|
||
🔀 Strange combinations converter like from Audio to Image | ||
|
||
## Installation | ||
|
||
Install client via pip. Ideally, `weird-converter` is well supported for Python >= 3.7. | ||
|
||
```bash | ||
pip3 install weird-converter | ||
``` | ||
|
||
## Usage | ||
|
||
Just run it like this: | ||
|
||
```python | ||
weird_converter.audio_to_image('audio.wav') # It only supports wav files, for now. | ||
``` | ||
|
||
## Future development | ||
|
||
* 🎶 Support other input audio types. | ||
* 📷 Implement image to audio conversion. | ||
* 📹 Implement audio to video conversion (and the same other way around). | ||
|
||
## Results | ||
|
||
### Audio to image | ||
|
||
From this [fanfare audio](https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/fanfare.wav) to this image: | ||
|
||
<p align="center"> | ||
<img alt="Fanfare image" src="https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/fanfare.png" width="30%"/> | ||
</p> | ||
|
||
Or from this [empty audio](https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/silent.wav), representing a silence, to this image: | ||
|
||
<p align="center"> | ||
<img alt="Silent image" src="https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/silent.png" width="30%"/> | ||
</p> | ||
|
||
## Development | ||
|
||
### Recommendations | ||
|
||
Usage of [virtualenv](https://realpython.com/blog/python/python-virtual-environments-a-primer/) is recommended for package library / runtime isolation. | ||
|
||
### Installation | ||
|
||
1. Setup virtual environment | ||
|
||
2. Install dependencies | ||
|
||
```bash | ||
pip3 install -r requirements.lock | ||
``` | ||
|
||
3. Install locally | ||
|
||
```bash | ||
pip3 install . | ||
``` | ||
|
||
## Contributing | ||
|
||
Suggestions, improvements, and enhancements are always welcome! If you have any issues, please do raise one in the Issues section. If you have an improvement, do file an issue to discuss the suggestion before creating a PR. | ||
|
||
All ideas – no matter how outrageous – welcome! | ||
|
||
## Authors | ||
|
||
- [Albert Suàrez](https://github.com/AlbertSuarez) | ||
|
||
## License | ||
|
||
Apache-2.0 © weird-converter |