update docs, authors, dates

Author: yomguy

README.rst

@@ -45,8 +45,27 @@ Thanks for your help!
 News
 =====
 
+1.1
+---
+
+- Core:
+
+  - Use the libav based aubio decoder by default (fastest audio to numpy array converter on the planet!)
+  - Add a VAMP based analyzer and a few plugins like VampFlatness, VampCrest, VampTempo, VampTuning, VampSpectralCentroid, VampSpectralKurtosis and VampSpectralSlope
+
+- Server:
+
+  - Fix a lot of asynchronous processing issues: now do every pre-processing, processing and post-processing tasks through the worker including source stream fetching from youtube
+  - Add a process monitor based on websocket
+  - Waveform automatically processed on Item.save()
+  - Make UUID really unique
+  - Reordering models
+  - Improve unit tests
+
+
 1.0
 ---
+
 * Server refactoring:
 
   * audio process run on items (REST API track's model)
@@ -115,37 +134,43 @@ For older news, please visit: https://github.com/Parisson/TimeSide/blob/master/N
 Documentation
 ==============
 
-* General documentation: https://timeside.readthedocs.io/en/latest/index.html
-* Tutorials: https://timeside.readthedocs.io/en/latest/tutorials/index.html
-* RESTful API: https://sandbox.wasabi.telemeta.org/timeside/api/docs/
-* Publications: https://github.com/Parisson/Telemeta-doc
-* Slides: https://ircam-web.github.io/timeside-slides/#1
-* Some (old) notebooks: http://mybinder.org/repo/thomasfillon/Timeside-demos
-* Player UI wiki (v1): https://github.com/Parisson/TimeSide/wiki/Ui-Guide
-* A player example (v1): http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
+- General documentation: https://timeside.readthedocs.io/en/latest/index.html
+- Tutorials: https://timeside.readthedocs.io/en/latest/tutorials/index.html
+- RESTful API: https://timeside.ircam.fr/timeside/api/docs/
+- Publications:
+
+  - https://github.com/Parisson/Telemeta-doc
+  - https://github.com/Ircam-WAM/timeside-papers
+
+- Slides: https://ircam-web.github.io/timeside-slides/#1
+- Some (old) notebooks: http://mybinder.org/repo/thomasfillon/Timeside-demos
+- Player UI v2: https://github.com/Ircam-WAM/timeside-player
+- Player UI wiki (v1): https://github.com/Parisson/TimeSide/wiki/Ui-Guide
+- A player example (v1): http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
 
 Install
 =======
 
 Thanks to Docker, Timeside is now fully available as a docker composition ready to work. The docker based composition bundles some powerfull applications and modern frameworks out-of-the-box like: Python, Conda, Numpy, Jupyter, Gstreamer, Django, Celery, Haystack, ElasticSearch, MySQL, Redis, uWSGI, Nginx and many more.
 
-First, install `Docker <https://store.docker.com/search?offering=community&q=&type=edition>`_ and `docker-compose <https://docs.docker.com/compose/>`_
+First, install `Docker <https://docs.docker.com/get-docker/>`_ and `docker-compose <https://docs.docker.com/compose/install/>`_
 
 Then clone TimeSide::
 
     git clone --recursive https://github.com/Parisson/TimeSide.git
     cd TimeSide
-    docker-compose pull
+    docker-compose up
 
 That's it! Now please go to the documentation to see how to use it.
 
 .. note::
-   If you need to user TimeSide outside a docker image please refer to the rules of the Dockerfile which is based on a Debian stable system. But we do not provide any kind of free support in this usercase anymore (the dependency list is now huge). To get commercial support in more various usecases, please reach the Parisson dev team.
+   If you need to user TimeSide outside a docker image please refer to the rules of the Dockerfile which is based on a Debian stable system. But we do not provide any kind of free support in this usercase anymore (the dependency list is now huge). To get commercial support in more various usecases, please reach the development team.
 
 Sponsors and Partners
 =====================
 
-* `Parisson <http://parisson.com>`_
+* `IRCAM <https://www.ircam.fr>`_ (Paris, France)
+* `Parisson <http://parisson.com>`_ (Paris, France)
 * `CNRS <http://www.cnrs.fr>`_: National Center of Science Research (France)
 * `Huma-Num <http://www.huma-num.fr/>`_: big data equipment for digital humanities (CNRS, France)
 * `CREM <http://www.crem-cnrs.fr>`_: French National Center of Ethomusicology Research (France)
@@ -154,7 +179,6 @@ Sponsors and Partners
 * `MNHN <http://www.mnhn.fr>`_ : Museum National d'Histoire Naturelle (Paris, France)
 * `C4DM <http://c4dm.eecs.qmul.ac.uk/>`_ : Center for Digital Music, Queen Mary University (London, United Kingdom)
 * `NYU Steinhardt <http://steinhardt.nyu.edu/music/>`_ : Music and Performing Arts Professions, New York University (New York, USA)
-* `IRCAM <https://www.ircam.fr>`_ : IRCAM (Paris, France)
 
 Related projects
 =================
@@ -172,7 +196,9 @@ Copyrights
 
 * Copyright (c) 2019, 2022 IRCAM
 * Copyright (c) 2006, 2022 Guillaume Pellerin
+* Copyright (c) 2022  Guillaume Piccarreta
 * Copyright (c) 2010, 2022 Paul Brossier
+* Copyright (c) 2021       Romain Herbelleau
 * Copyright (c) 2019, 2020 Antoine Grandry
 * Copyright (c) 2006, 2019 Parisson SARL
 * Copyright (c) 2013, 2017 Thomas Fillon

app/bin/install_yaafe.sh

@@ -20,6 +20,8 @@ pushd $VIRTUAL_ENV/src
 
 set -x
 
+echo $yaafe_git
+
 [ ! -d Yaafe ] && git clone $yaafe_git || true
 
 pushd Yaafe

docker-compose.yml

@@ -42,6 +42,7 @@ services:
     volumes:
       - ./app:/srv/app
       - ./bin:/srv/bin
+      - ./docs:/src/docs
       - ./timeside:/srv/lib/timeside/timeside
       - ./tests:/srv/lib/timeside/tests
       - ./lib/plugins:/srv/lib/plugins

docs/Makefile

@@ -6,7 +6,7 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = build
-DEPENDENCIES  = sphinx numpydoc
+DEPENDENCIES  = sphinx numpydoc git+https://github.com/c-w/ghp-import.git
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4

docs/build.sh

@@ -1,7 +1,5 @@
 #!/bin/sh
 
-pip install -e git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github
-
 make install_deps
 make gh-pages
 make readme

docs/requirements-docs.txt

@@ -1,10 +1,10 @@
-Sphinx==2.4.1
-Django==2.2.24
-sphinx-rtd-theme==0.4.3
-sphinxcontrib-applehelp==1.0.1
-sphinxcontrib-devhelp==1.0.1
-sphinxcontrib-htmlhelp==1.0.2
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.2
-sphinxcontrib-serializinghtml==1.1.3
-numpydoc==0.9.2
+Sphinx
+Django
+sphinx-rtd-theme
+sphinxcontrib-applehelp
+sphinxcontrib-devhelp
+sphinxcontrib-htmlhelp
+sphinxcontrib-jsmath
+sphinxcontrib-qthelp
+sphinxcontrib-serializinghtml
+numpydoc

docs/source/conf.py

@@ -33,7 +33,8 @@
               'sphinx.ext.coverage',
               'sphinx.ext.viewcode',
               'sphinx.ext.autosummary',
-              'sphinx.ext.doctest', 'numpydoc',
+              'sphinx.ext.doctest',
+              'numpydoc',
               ]
 
 doctest_path = os.path.abspath('../../')
@@ -58,7 +59,7 @@
 
 # General information about the project.
 project = u'TimeSide'
-copyright = u'2014-2019 Guillaume Pellerin, Paul Brossier, Thomas Fillon, Antoine Grandry'
+copyright = u'2014-2022 Guillaume Pellerin, Paul Brossier, Thomas Fillon, Antoine Grandry'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -68,10 +69,10 @@
 # TODO: enable to get TimeSide version without `import timeside.core`  
 # The short X.Y version.
 # version = '.'.join(TimeSideVersion.split('.')[0:2])
-version = '1.0'
+version = '1.1'
 # The full version, including alpha/beta/rc tags.
 # release = TimeSideVersion
-release = '1.0'
+release = '1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/copyright.rst

@@ -2,9 +2,10 @@
 Copyrights
 ==========
 
-* Copyright (c) 2019, 2021 IRCAM
-* Copyright (c) 2006, 2021 Guillaume Pellerin
-* Copyright (c) 2010, 2021 Paul Brossier
+* Copyright (c) 2019, 2022 IRCAM
+* Copyright (c) 2006, 2022 Guillaume Pellerin
+* Copyright (c) 2022  Guillaume Piccarreta
+* Copyright (c) 2010, 2022 Paul Brossier
 * Copyright (c) 2021       Romain Herbelleau
 * Copyright (c) 2019, 2020 Antoine Grandry
 * Copyright (c) 2006, 2019 Parisson SARL

docs/source/core_api/index.rst

@@ -2,6 +2,10 @@
 TimeSide core API
 =================
 
+TimeSide is first a python framework enabling low and high level audio analysis, imaging, transcoding, streaming and labelling. Its high-level API is designed to enable complex processing on very large datasets of any audio or video assets with a plug-in architecture, a secure scalable backend and an extensible dynamic web frontend. Some usecases: scaled audio computing (filtering, machine learning, etc), web audio visualization, audio process prototyping, realtime and on-demand transcoding and streaming over the web, automatic segmentation and labelling synchronized with audio events
+
+Because there are a lot of tools available in the Python ecosystem dedicated to music information retrieval, machine learning and data analysis, we have decided to embed all main ones: Aubio\cite{aubio}, Yaafe\cite{yaafe_ISMIR2010}, Essentia\cite{essentia}, VAMP\cite{vamp-plugins}, librosa\cite{librosa}, GStreamer, TensorFlow, Torch, PyTorch, scikit-learn, Jupyter, Pandas and Pytables. They are used to develop native TimeSide plugins though its simple processing API.
+
 
 .. toctree::
    :maxdepth: 2

docs/source/doc.rst

@@ -2,11 +2,16 @@
 Documentation
 ==============
 
-* General documentation: https://timeside.readthedocs.io/en/latest/index.html
-* Tutorials: https://timeside.readthedocs.io/en/latest/tutorials/index.html
-* RESTful API: https://sandbox.wasabi.telemeta.org/timeside/api/docs/
-* Publications: https://github.com/Parisson/Telemeta-doc
-* Slides: https://ircam-web.github.io/timeside-slides/#1
-* Some (old) notebooks: http://mybinder.org/repo/thomasfillon/Timeside-demos
-* Player UI wiki (v1): https://github.com/Parisson/TimeSide/wiki/Ui-Guide
-* A player example (v1): http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
+- General documentation: https://timeside.readthedocs.io/en/latest/index.html
+- Tutorials: https://timeside.readthedocs.io/en/latest/tutorials/index.html
+- RESTful API: https://timeside.ircam.fr/timeside/api/docs/
+- Publications:
+
+  - https://github.com/Parisson/Telemeta-doc
+  - https://github.com/Ircam-WAM/timeside-papers
+
+- Slides: https://ircam-web.github.io/timeside-slides/#1
+- Some (old) notebooks: http://mybinder.org/repo/thomasfillon/Timeside-demos
+- Player UI v2: https://github.com/Ircam-WAM/timeside-player
+- Player UI wiki (v1): https://github.com/Parisson/TimeSide/wiki/Ui-Guide
+- A player example (v1): http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/