Add the files

Author: Skyluker4

.gitignore

@@ -20,7 +20,6 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -50,6 +49,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -72,6 +72,7 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -82,7 +83,9 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -127,3 +130,15 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+
+# Visual Studio Code
+.vscode/

README.md

@@ -1,2 +1,109 @@
 # Audfill
-Find song's info and rename files.
+
+A python script to find song's info and rename them by looking them up on [audd.io](https://audd.io/).
+
+An [API token](https://docs.audd.io/#authentication-and-limits) is required to do more than 10 requests per day.
+
+## Installation
+
+### Requirements
+
+- Python >= 3.7
+- FFmpeg must be installed on the system and in the PATH
+- Python modules:
+  - click
+  - requests
+  - validators
+  - pydub
+
+### PIP
+
+```bash
+python -m pip install audfill
+```
+
+### Local Installation
+
+Run inside Audfill directory.
+
+```bash
+python -m pip install -e .
+```
+
+## Usage
+
+A sound file must always be specified. Most sound files are supported (anything that FFmpeg and Pydub supports).
+
+Specifiying no options will send the request, but not do anything with the response.
+
+An example to print information about a song:
+
+```bash
+audfill song.mp3 -i
+```
+
+### Wildcards
+
+Wildcards are supported and will loop though all files in a directory. The following example prints all the information about MP3s in the current directory.
+
+```bash
+audfill *.mp3 -i
+```
+
+### Sources
+
+This script is also capable of getting additional data from Apple Music, Spotify, Napster, and Deezer. To explicitly get info from these sources, use ```-s [source]```. Data from sources listed first will be used for naming files. Sources will be implicitly added as necessary unless the minimum flag is specified (```-n```).
+
+### API Token
+
+An API key can be specified with the option ```-t``` or can be read automatically with the environment variable ```AUDDIOKEY```.
+
+```bash
+audfill song.mp3 -k exampleToken123
+```
+
+### File naming
+
+For use with renaming files or downloading art and previews. File extension will automatically be added, do not add your own extension.
+
+- Percent Symbol: %%
+- Filename:       %f
+- Artist(s)       %a
+- Composer:       %c
+- Album:          %b
+- Genre(s):       %g
+- Title:          %T
+- Short Title:    %t
+- Explicit:       %x
+- ISRC:           %i
+- Disk Number:    %k
+- Track Number:   %#
+- Release Date:
+  - Capital letters represent extended (ex. 1997, 03), lowercase letters represent short dates (ex. 97, 3)
+    - %Y, %y
+    - %M, %m
+    - %D, %d
+
+Example (Renames to **Artist - Title.mp3**):
+
+```bash
+audfill song.mp3 -r '%a - %T'
+```
+
+### Running with Python
+
+```bash
+python audfill.py [filename] [options]
+```
+
+### Running with Python PIP
+
+```bash
+python -m audfill [filename] [options]
+```
+
+### Running executable
+
+```bash
+audfill [filename] [options]
+```