Merge pull request #6 from timmahrt/pyacoustics_2

Pyacoustics v2

CHANGELOG.md

@@ -0,0 +1,23 @@
+
+# PyAcoustics Changelog
+
+*PyAcoustics uses semantic versioning (Major.Minor.Patch)*
+
+Ver 2.0 (July 15, 2023)
+- drop support for Python 2.7
+
+Ver 1.0 (June 7, 2015)
+- first public release.
+
+
+## Features as they are added
+
+I was not using semantic versioning at the time I added these features and did not bump the version number.
+
+Mask speech with speech shaped noise
+(March 21, 2016)
+
+Find syllable nuclei/estimate speech rate using Uwe Reichel's matlab code
+(July 29, 2015)
+
+Find the valley bottom between peaks (July 7th, 2015)

DEVELOP.md

@@ -0,0 +1,28 @@
+
+These are development notes for myself
+
+## Documentation
+
+Documentation is generated with the following command:
+`pdoc pyacoustics -d google -o docs`
+
+A live version can be seen with
+`pdoc pyacoustics -d google`
+
+pdoc will read from pyacoustics, as installed on the computer, so you may need to run `pip install .` if you want to generate documentation from a locally edited version of pyacoustics.
+
+## Tests
+
+Tests are run with
+
+`pytest --cov=pyacoustics tests/`
+
+## Release
+
+Releases are built and deployed with:
+
+`python setup.py bdist_wheel sdist`
+
+`twine upload dist/*`
+
+Don't forget to tag the release.

README.rst

@@ -48,22 +48,11 @@ What can you do with this library?
 Major revisions
 ================
 
-Ver 1.0 (June 7, 2015)
+*Praatio uses semantic versioning (Major.Minor.Patch)*
 
-- first public release.
+Please view [CHANGELOG.md](https://github.com/timmahrt/pyAcoustics/blob/main/CHANGELOG.md) for version history.
 
 
-Features as they are added
-===========================
-
-Mask speech with speech shaped noise
-(March 21, 2016)
-
-Find syllable nuclei/estimate speech rate using Uwe Reichel's matlab code
-(July 29, 2015) 
-
-Find the valley bottom between peaks (July 7th, 2015)
-
 Requirements
 ================
 
@@ -92,9 +81,6 @@ My praatIO library is used extensively and can be downloaded
 Installation
 ================
 
-If you on Windows, you can use the installer found here (check that it is up to date though)
-`Windows installer <http://www.timmahrt.com/python_installers>`_
-
 PyAcoustics is on pypi and can be installed or upgraded from the command-line shell with pip like so::
 
     python -m pip install pyacoustics --upgrade
@@ -138,8 +124,7 @@ See the example folders for a few real-world examples using this library.
     `Uwe Reichel <http://www.phonetik.uni-muenchen.de/~reichelu/>`_
     that estimates the location of syllable boundaries.
 
-
-Citing LMEDS
+Citing PyAcoustics
 ===============
 
 PyAcoustics is general purpose coding and doesn't need to be cited