This PR has two goals, both for the upcoming v1.0 release: pyproject.toml and README.md.
pyproject.toml
I've updated the TOML file. Since we're targeting Python 3.12, I've added its classifier. As for topics, I've added healthcare and removed both text processing and non-specific classifiers (i.e. all other* classifiers, that may be useful when your package don't fit in any specific classifier, but that's not music's case).
As for keywords, I've removed quite a few based on this logic: keywords are not shown on pypi but used while searching, so:
I favoured shorter keywords that contains longer ones (for example, "synth" will also show "syntheses");
I removed sub-category keywords such as "ADSR" or "tremolo" because if I'm looking for a package that does that, first thing I'll do is looking for "music", or "filter";
I kept very specific keywords such as "campanology" or "signal processing" because I figured that these are narrow fields and someone might look for those.
Other than those, I fixes some placeholder text and a few cosmetic issues.
README.md
I've reworked the README.md based on the old one to reflect a few changes. The package structure must be reviewed after we deal with legacy code (both inside the legacy folder and in other files), but the idea here is that when we have docstringed everything, it should be fairly easy to output some documentation, and so easier to look for a specific function.
I've expanded a little bit the installation how-to. I have to check on Windows how to install all dependencies, but it should be possible to list a couple of package managers. As for Linux, maybe add Fedora and/or Arch?
Then I've split the old example in five different example scripts inside a dedicated folder. Ideally, we'll also move all sandbox scripts in there too after speech and singing is revisioned.
This PR has two goals, both for the upcoming v1.0 release: pyproject.toml and README.md.
pyproject.toml
I've updated the TOML file. Since we're targeting Python 3.12, I've added its classifier. As for topics, I've added healthcare and removed both text processing and non-specific classifiers (i.e. all other* classifiers, that may be useful when your package don't fit in any specific classifier, but that's not music's case).
As for keywords, I've removed quite a few based on this logic: keywords are not shown on pypi but used while searching, so:
Other than those, I fixes some placeholder text and a few cosmetic issues.
README.md
I've reworked the README.md based on the old one to reflect a few changes. The package structure must be reviewed after we deal with legacy code (both inside the legacy folder and in other files), but the idea here is that when we have docstringed everything, it should be fairly easy to output some documentation, and so easier to look for a specific function.
I've expanded a little bit the installation how-to. I have to check on Windows how to install all dependencies, but it should be possible to list a couple of package managers. As for Linux, maybe add Fedora and/or Arch?
Then I've split the old example in five different example scripts inside a dedicated folder. Ideally, we'll also move all sandbox scripts in there too after speech and singing is revisioned.