Skip to content

Commit 26a8ec9

Browse files
committed
Improved README
1 parent 26700c2 commit 26a8ec9

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,88 @@
1-
# weird-converter
1+
# Weird converter
2+
3+
[![PyPI version](https://badge.fury.io/py/weird-converter.svg)](https://pypi.org/project/weird-converter/)
4+
[![Downloads](https://pepy.tech/badge/weird-converter)](https://pepy.tech/project/weird-converter)
5+
[![Downloads](https://pepy.tech/badge/weird-converter/month)](https://pepy.tech/project/weird-converter/month)
6+
[![Downloads](https://pepy.tech/badge/weird-converter/week)](https://pepy.tech/project/weird-converter/week)
7+
<br>
8+
[![HitCount](http://hits.dwyl.io/AlbertSuarez/weird-converter.svg)](http://hits.dwyl.io/AlbertSuarez/weird-converter)
9+
![Python package](https://github.com/AlbertSuarez/weird-converter/workflows/Python%20package/badge.svg)
10+
[![GitHub stars](https://img.shields.io/github/stars/AlbertSuarez/weird-converter.svg)](https://GitHub.com/AlbertSuarez/weird-converter/stargazers/)
11+
[![GitHub forks](https://img.shields.io/github/forks/AlbertSuarez/weird-converter.svg)](https://GitHub.com/AlbertSuarez/weird-converter/network/)
12+
[![GitHub contributors](https://img.shields.io/github/contributors/AlbertSuarez/weird-converter.svg)](https://GitHub.com/AlbertSuarez/weird-converter/graphs/contributors/)
13+
214
🔀 Strange combinations converter like from Audio to Image
15+
16+
## Installation
17+
18+
Install client via pip. Ideally, `weird-converter` is well supported for Python >= 3.7.
19+
20+
```bash
21+
pip3 install weird-converter
22+
```
23+
24+
## Usage
25+
26+
Just run it like this:
27+
28+
```python
29+
weird_converter.audio_to_image('audio.wav') # It only supports wav files, for now.
30+
```
31+
32+
## Future development
33+
34+
* 🎶 Support other input audio types.
35+
* 📷 Implement image to audio conversion.
36+
* 📹 Implement audio to video conversion (and the same other way around).
37+
38+
## Results
39+
40+
### Audio to image
41+
42+
From this [fanfare audio](https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/fanfare.wav) to this image:
43+
44+
<p align="center">
45+
<img alt="Fanfare image" src="https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/fanfare.png" width="30%"/>
46+
</p>
47+
48+
Or from this [empty audio](https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/silent.wav), representing a silence, to this image:
49+
50+
<p align="center">
51+
<img alt="Silent image" src="https://raw.githubusercontent.com/AlbertSuarez/weird-converter/master/examples/from_audio/silent.png" width="30%"/>
52+
</p>
53+
54+
## Development
55+
56+
### Recommendations
57+
58+
Usage of [virtualenv](https://realpython.com/blog/python/python-virtual-environments-a-primer/) is recommended for package library / runtime isolation.
59+
60+
### Installation
61+
62+
1. Setup virtual environment
63+
64+
2. Install dependencies
65+
66+
```bash
67+
pip3 install -r requirements.lock
68+
```
69+
70+
3. Install locally
71+
72+
```bash
73+
pip3 install .
74+
```
75+
76+
## Contributing
77+
78+
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.
79+
80+
All ideas – no matter how outrageous – welcome!
81+
82+
## Authors
83+
84+
- [Albert Suàrez](https://github.com/AlbertSuarez)
85+
86+
## License
87+
88+
Apache-2.0 © weird-converter

0 commit comments

Comments
 (0)