Overview
=========
-Telemeta is a free and open source web audio archiving software which introduces useful and secure methods to backup, index, transcode, analyse and publish any digitalized audio file with extensive metadata. It is dedicated to collaborative media archiving projects, research laboratories and digital humanities - and especially in ethnomusicological use cases - who wants to easily organize, backup and publish documented sound collections of audio files, CDs, digitalized vinyls and magnetic tapes over a strong database, in accordance with open web standards.
+Telemeta is a free and open source collaborative multimedia asset management system (MAM) which introduces fast and secure methods to archive, backup, transcode, analyse, annotate and publish any digitalized video or audio file with extensive metadata. It is dedicated to collaborative media archiving projects, research laboratories and digital humanities - especially in ethno-musicological use cases - who need to easily organize and publish documented sound collections of audio files, CDs, digitalized vinyls and magnetic tapes over a strong database, through a smart and secure platform, in accordance with open web standards.
Key features:
* Secure archiving, editing and publishing of audio files over internet.
* Pure HTML web user interface including dynamical forms and smart workflows
-* Smart dynamical and skinnable audio player (thanks to TimeSide and SoundManager2)
-* "On the fly" audio analyzing, transcoding and metadata embedding based on an easy plugin architecture
-* Social cumulative indexing with semantic ontologies and timecoded markers
-* Multi-format support : FLAC, OGG, MP3, WAV and more
+* "On the fly" audio analyzing and transcoding thanks to TimeSide_
+* Smart dynamical and skinnable audio player with annotations
+* Collaborative indexing with semantic ontologies and timecoded markers
+* Multi-format support : FLAC, OGG, MP3, WAV, MP4, WebM (video) and more
* User management with individual desk, lists, profiles and rights
* Playlist management for all users with CSV data export
* Geo-Navigator for audio geolocalization
* OAI-PMH data provider
* RSS feed generators
* XML and ZIP serialized backups
+* EPUB3 "audio book" collection exporter
* SQLite, MySQL, PostgreSQL or Oracle DB backends
* Multi-language support (now english and french)
-* Video support (EXPERIMENTAL, WebM only)
+* Run on any OS
-This web audio CMS is exclusively based on open source modules and can be run on any Unix or Linux system.
-It is mostly written in Python and JavaScript.
+Telemeta has been developed since 2006 and is based exclusively on 100% open source modules.
-The processing engine of Telemeta is a separate project called `TimeSide <https://github.com/yomguy/timeside/>`_ as an open web audio pocessing framework written in Python.
+It is mostly written in Python, HTML5 and JavaScript.
+
+The *Telemeta* name stands for *Tele* as "remote access" and *meta* for "metadata".
+
+|version| |downloads| |travis_master| |coverage_master|
+
+.. |version| image:: https://img.shields.io/pypi/v/telemeta.svg
+ :target: https://pypi.python.org/pypi/Telemeta/
+ :alt: Version
+
+.. |downloads| image:: https://img.shields.io/pypi/dm/telemeta.svg
+ :target: https://pypi.python.org/pypi/Telemeta/
+ :alt: Downloads
+
+.. |travis_master| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=master
+ :target: https://travis-ci.org/Parisson/Telemeta/
+ :alt: Travis
+
+.. |coverage_master| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=master
+ :target: https://coveralls.io/r/Parisson/Telemeta?branch=master
+ :alt: Coverage
+
+
+Funding and support
+===================
+
+To fund this long time libre and open source project, we need your explicit support. So if you use Telemeta in production or even in a development or experimental setup, please let us know by:
+
+* staring or forking the project on `GitHub <https://github.com/Parisson/TimeSide>`_
+* tweeting something to `@parisson_studio <https://twitter.com/parisson_studio>`_ or `@telemeta <https://twitter.com/telemeta>`_
+* drop us an email <support@parisson.com>
+
+Thank you so much for your help!
News
-======
+=====
+
+1.6
+++++
+
+* Provide a docker image and composition for the full Telemeta application bundle.
+
+ One month after the publication of docker-compose around march 2015, we had managed to build a prototyped composition which bundled all the dependencies of Telemeta and TimeSide. It took almost one year to deeply investigate all the capabilities of Docker and various images to finally release a propoer composition which bundles all the necessary applications and modules. So we can say that Telemeta is now usable on **any OS** in 5 mn! B-)
+
+* Full refactoring of the search engine and interface using django-haystack and ElasticSearch with new faceting and smart filtering features
+* Add an automatic EPUB3 ebook exporter for corpus and collections embedding metadata, image and audio materials.
+* Install new useful tools and modules like Conda, Jupyter notebook and `many others <https://github.com/Parisson/TimeSide/blob/master/conda-requirements.txt>`_
+* Upgrade of every dependency bundle in the composition
+* Many, many bugfixes
+* Thanks to all partners for this **huge** release!
1.5.1
++++++
* Better locale / pages management
* A better management of RTL for arabic page style
-1.5
-+++++
-
-* Compatible with Django 1.6.x
-* Compatible with TimeSide 0.7.x
-* Huge refactor of all forms, detail and edit views
-* Main styles (buttons, tabs) are now based Bootstrap 3 and JQuery 2.1
-* Update models and views as needed by the CREM
-* New depedencies
-
-See previous releases `here <https://github.com/Parisson/Telemeta/releases>`_.
+`More changes <http://parisson.github.io/Telemeta/category/releases.html>`_.
Examples
========
-* `Sound archives of the French Ethnomusicology Research Center (CREM) and the Musée de l'Homme <http://archives.crem-cnrs.fr>`_ :
-
- * a 120 year old ethnomusicologic database,
- * more than 5000 geolocated collections,
- * more than 32000 geolocated items,
- * more than 11000 sounds included
- * 1.5 To of original music files accessible online.
- * started in june 2011
-
-* `Sound archives of the team "Lutherie, Acoustique et Musique" (LAM) of the IJLRDA institute - University Pierre et Marie Curie (Paris 6) <http://telemeta.lam.jussieu.fr>`_ :
-
- * original musical instruments recorded for research purposes
- * started in sept. 2012
-
-* `Sound archives of Parisson Studio <http://parisson.telemeta.org>`_
-
+* `Sound archives of the French Ethnomusicology Research Center (CREM, CNRS) and the Musée de l'Homme <http://archives.crem-cnrs.fr>`_
+* `Sound archives of the team "Lutherie, Acoustique et Musique" (LAM) of the IJLRDA institute - University Pierre et Marie Curie (Paris 6) <http://telemeta.lam.jussieu.fr>`_
+* `Phonothèque Nationale du Centre des Musiques Arabes et Méditerranéennes <http://phonotheque.cmam.tn/>`_
* `Scaled BIOdiversity (SABIOD) <http://sabiod.telemeta.org>`_
+* `Sound archives of Parisson Studio <http://parisson.telemeta.org>`_
Demo
http://demo.telemeta.org
-login: demo
-password: demo
+login: admin
+
+password: admin
Install
=======
-See `INSTALL.rst <http://github.com/yomguy/Telemeta/blob/master/INSTALL.rst>`_ and `telemeta.org <http://telemeta.org>`_ for more informations.
+Thanks to Docker, Telemeta 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.
+
+On Linux, first install `Git <http://git-scm.com/downloads>`_, `Docker engine <https://docs.docker.com/installation/>`_ and `docker-compose <https://docs.docker.com/compose/install/>`_ and open a terminal.
+
+On MacOSX or Windows install the `Docker Toolbox <https://www.docker.com/products/docker-toolbox>`_ and open a Docker Quickstart Terminal.
+
+Then clone Telemeta::
+
+ git clone --recursive https://github.com/Parisson/Telemeta.git
+ cd Telemeta
+
+
+Start it up
+===========
+
+For a production environment setup::
+
+ docker-compose up
+
+Then browse the app at http://localhost:8000/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows)
+
+To start the application in DEBUG mode::
+
+ docker-compose -f docker-compose.yml -f env/debug.yml up
+
+
+Backup / Restore
+================
+
+To backup the database in the data/backup/ folder, run this in **another** terminal (or a Docker Quickstart Terminal)::
+
+ docker-compose run db /srv/scripts/sql/backup_db.sh
+
+To restore the last backuped database from the data/backup/ folder, run this in **another** terminal (or a Docker Quickstart Terminal)::
+
+ docker-compose run db /srv/scripts/sql/restore_db.sh
+
+If the app is broken after a restore script, restart the composition with::
+
+ docker-compose restart
API / Documentation
====================
+* Official website: http://telemeta.org
* Publications : https://github.com/Parisson/Telemeta-doc
* API : http://files.parisson.com/doc/telemeta/
* Player : https://github.com/Parisson/TimeSide/
* Example : http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
-Related software projects
-==========================
-
- * `TimeSide <https://github.com/yomguy/timeside/>`_: high level python audio processing framework
- * `Diadems <http://www.irit.fr/recherches/SAMOVA/DIADEMS/fr/welcome/&cultureKey=en>`_ Description, Indexation, Access to Sound and Ethnomusicological Documents, funded by the French Research Agency (ANR CONTINT 2012)
- * `TimeSide-Diadems <https://github.com/ANR-DIADEMS/timeside-diadems>`_: a set of Timeside plugins developed during the Diadems project
-
-
Development
===========
:alt: Coverage
-You are welcome to participate to the development of the Telemeta project.
-The official project site is `telemeta.org <http://telemeta.org>`_ but you can find a mirror on `GitHub <https://github.com/Parisson/Telemeta>`_.
-
-To get and run the lastest development version::
+To start the application in a development environment setup::
- sudo apt-get install git
- git clone --recursive https://github.com/Parisson/Telemeta.git
cd Telemeta
+ git pull
git checkout dev
- sudo pip install -e .
- export PYTHONPATH=$PYTHONPATH:`pwd`
+ docker-compose -f docker-compose.yml -f env/dev.yml up
+
+Then browse the app at http://localhost:9000/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows)
+
+You are welcome to participate to the development by forking the Telemeta project on `GitHub <https://github.com/Parisson/Telemeta>`_.
+
+To build your own composition::
+ docker-compose -f docker-compose.yml -f env/dev.yml -f env/build.yml build
-Bugs and feedback
-=================
-You are welcome to freely use this application in accordance with its licence.
-If you find some bugs, PLEASE leave a ticket on this page:
+Bugs, issues, ideas
+===================
+
+If you find some bugs or have good ideas for enhancement, please leave a issue on GitHub with the right label:
https://github.com/Parisson/Telemeta/issues/new
You can also leave some ticket to request some new interesting features for the next versions and tweet your ideas to `@telemeta <https://twitter.com/telemeta>`_.
-And even if Telemeta suits you, please give us some feedback !
+And remember: even if Telemeta suits you, please give us some feedback !
-Contact
+License
=======
-Homepage: http://telemeta.org
-
-Emails:
-
- * Guillaume Pellerin <yomguy@parisson.com>,
- * Thomas Fillon <thomas@parisson.com>
- * Anas Ghrab <anas.ghrab@gmail.com>
- * Olivier Guilyardi <olivier@samalyse.com>,
- * Riccardo Zaccarelli <riccardo.zaccarelli@gmail.com>
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
-Twitter:
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
- * https://twitter.com/telemeta
- * https://twitter.com/parisson_studio
- * https://twitter.com/yomguy
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
-License
-=======
+Sponsors and partners
+======================
-CeCILL v2, compatible with GPL v2 (see `LICENSE <http://github.com/yomguy/Telemeta/blob/master/LICENSE.txt>`_)
+ * CNRS_ : Centre National de la Recherche Scientifique (French Natianal Research and Scientific Center)
+ * MCC_ : Ministère de la Culture et de la Communication (the french Ministry of the Culture and Communication)
+ * ANR_ : Agence Nationale de la Recherche (French Research Agency)
+ * UPMC_ : University Pierre et Marie Curie (Paris 6, France)
+ * CREM_ : Centre de Recherche en Ethnomusicologie (Ethnomusicology Research Center)
+ * LAM_ : Equipe Lutherie, Acoustique et Musique de l'IJLRDA_
+ * IJLRDA_ : Institut Jean le Rond d'Alembert (Paris, France)
+ * Parisson_ : Open audio development agency for science and arts (Paris, France)
+ * MNHN_ : Museum National d'Histoire Naturelle (National Museum of Biology, Paris, France)
+ * U-Paris10_ : University Paris Oues Nanterre (Paris 10, France)
+ * MuseeDelHomme_ : Musée de l'Homme (Paris, France)
+ * LIMSI_ : Laboratoire d'Informatique pour la Mécanique et les Sciences de l'Ingénieur
+ * LABRI_ : Laboratoire Bordelais de Recherche en Informatique
+ * HumaNum_ : TGIR des humanités numériques
+ * IRCAM_ : Institut de Recherche et de Coordination Acoustique / Musique (Paris, France)
+ * QMUL_ : Queen Mary University (London, UK)
-Sponsors
-========
+Related research projects
+==========================
-The Telemeta project is developed by Parisson. It is sponsored by :
-
- * CNRS : Centre National de la Recherche Scientifique (the french Natianal Research and Scientific Center)
- http://cnrs.fr
- * CREM : Centre de Recherche en Ethnomusicology (the french Ethnomusicology Research Center)
- http://www.crem-cnrs.fr
- * LAM : Equipe Lutherie, Acoustique et Musique de l'Université Pierre et Marie Curie de Paris
- (Instrument design, Acoustic and Music team of the Pierre & Marie Curie University)
- http://www.lam.jussieu.fr/
- * MuCEM : Musée des Civilisations de l'Europe et de la Méditerranée
- http://www.musee-europemediterranee.org
- * MMSH : Maison Méditerranéenne des Sciences de l'Homme
- http://www.mmsh.univ-aix.fr/
- * MNHN : Museum d'Histoire Naturelle (Paris, France)
- http://www.mnhn.fr
+* DIADEMS_ : Description, Indexation, Access to Sound and Ethnomusicological Documents, funded by the French Research Agency (ANR_ CONTINT 2012), involving IRIT_, CREM_, LAM_, LABRI_, LIMSI_, MNHN_, Parisson_
+* TimeSide-DIADEMS_ : a set of Timeside plugins developed during the DIADEMS_ project
+* DaCaRyH_ : Le rythme calypso à travers l’histoire : une approche en sciences des données (AHRC_ “Care for the Future” et le Labex-Passé_Présent_ "Les passés dans le présent")
+* Kamoulox_ : Démixage en ligne de larges archives sonores (ANR_ Jeune Chercheur 2015)
+* WASABI_ : Web Audio Semantic Aggregated in the Browser for Indexation (ANR_ 2016, currently submitted)
+
+
+.. _Telemeta: http://telemeta.org
+.. _TimeSide: https://github.com/Parisson/TimeSide/
+.. _OAI-PMH: http://fr.wikipedia.org/wiki/Open_Archives_Initiative_Protocol_for_Metadata_Harvesting
+.. _Parisson: http://parisson.com
+.. _CNRS: http://www.cnrs.fr
+.. _MCC: http://www.culturecommunication.gouv.fr
+.. _CREM: http://www.crem-cnrs.fr
+.. _HumaNum: http://www.huma-num.fr
+.. _IRIT: http://www.irit.fr
+.. _LIMSI: http://www.limsi.fr/index.en.html
+.. _LAM: http://www.lam.jussieu.fr
+.. _LABRI: http://www.labri.fr
+.. _MNHN: http://www.mnhn.fr
+.. _MMSH: http://www.mmsh.univ-aix.fr
+.. _UPMC: http://www.upmc.fr
+.. _DIADEMS_project: http://www.irit.fr/recherches/SAMOVA/DIADEMS/fr/welcome/&cultureKey=en
+.. _ANR: http://www.agence-nationale-recherche.fr/
+.. _SABIOD: http://sabiod.telemeta.org
+.. _CHANGELOG: http://github.com/Parisson/Telemeta/blob/master/CHANGELOG.rst
+.. _Publications: https://github.com/Parisson/Telemeta-doc
+.. _API : http://files.parisson.com/doc/telemeta/
+.. _Player : https://github.com/Parisson/TimeSide/
+.. _Example : http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
+.. _Homepage: http://telemeta.org
+.. _GitHub: https://github.com/Parisson/Telemeta/
+.. _IJLRDA: http://www.dalembert.upmc.fr/ijlrda/
+.. _Labex-Passé_Présent: http://passes-present.eu/
+.. _U-Paris10: http://www.u-paris10.fr/
+.. _MuseeDelHomme: http://www.museedelhomme.fr/
+.. _IRCAM: http://www.ircam.fr
+.. _TimeSide-DIADEMS: https://github.com/ANR-DIADEMS/timeside-diadems
+.. _DaCaRyH: http://archives.crem-cnrs.fr/archives/fonds/CNRSMH_DACARYH/
+.. _Kamoulox: http://www.agence-nationale-recherche.fr/?Projet=ANR-15-CE38-0003
+.. _AHRC: http://www.ahrc.ac.uk/
projects / telemeta.git / commitdiff