source: README.rst

Last change on this file was 931873e, checked in by Guillaume Pellerin <yomguy@…>, 35 hours ago

fix logo and home styles

  • Property mode set to 100644
File size: 7.4 KB
Line 
1===============================================
2Telemeta: open web audio platform with semantics
3===============================================
4
5|version| |downloads| |travis_master| |coverage_master|
6
7.. |travis_master| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=master
8   :target: https://travis-ci.org/Parisson/Telemeta/
9   :alt: Travis
10
11.. |version| image:: https://pypip.in/version/Telemeta/badge.png
12   :target: https://pypi.python.org/pypi/Telemeta/
13   :alt: Version
14
15.. |downloads| image:: https://pypip.in/download/Telemeta/badge.svg
16   :target: https://pypi.python.org/pypi/Telemeta/
17   :alt: Downloads
18
19.. |coverage_master| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=master
20   :target: https://coveralls.io/r/Parisson/Telemeta?branch=master
21   :alt: Coverage
22
23
24Overview
25=========
26
27Telemeta 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.
28
29Key features:
30
31 * Secure archiving, editing and publishing of audio files over internet.
32 * Pure HTML web user interface including dynamical forms and smart workflows
33 * Smart dynamical and skinnable audio player (thanks to  TimeSide and  SoundManager2)
34 * "On the fly" audio analyzing, transcoding and metadata embedding based on an easy plugin architecture
35 * Social cumulative indexing with semantic ontologies and timecoded markers
36 * Multi-format support : FLAC, OGG, MP3, WAV and more
37 * User management with individual desk, lists, profiles and rights
38 * Playlist management for all users with CSV data export
39 * Geo-Navigator for audio geolocalization
40 * High level search engine
41 * DublinCore compatibility
42 * OAI-PMH data provider
43 * RSS feed generators
44 * XML and ZIP serialized backups
45 * SQLite, MySQL, PostgreSQL or Oracle DB backends
46 * Multi-language support (now english and french)
47 * Video support (EXPERIMENTAL, WebM only)
48
49This web audio CMS is exclusively based on open source modules and can be run on any Unix or Linux system.
50It is mostly written in Python and JavaScript.
51
52The 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.
53
54
55News
56======
57
581.5
59+++++
60
61 * Compatible with Django 1.6.x
62 * Compatible with TimeSide 0.6.x
63 * Huge refactor of all forms, detail and edit views
64 * Main styles (buttons, tabs) are now based Bootstrap 3 and JQuery 2.1
65 * Update models and views as needed by the CREM
66 * New depedencies
67
681.4.6
69+++++
70
71 * Drastically improve collection zip packaqe streaming thanks to zipstream (check NEW dependencies)
72 * Compatible with TimeSide >= 0.5.2
73 * Add URL field to item so that a external sound can be indexed and streamed
74 * Add TIMESIDE_AUTO_ZOOM in settings to auto toggle the player in zooming mode
75 * Add TIMESIDE_DEFAULT_GRAPHER_ID in settings to select the default grapher in the player
76 * Add minor migrations
77 * Fix marker display bug
78
79
80See also the `full changelog <http://github.com/yomguy/Telemeta/blob/master/CHANGELOG.rst>`_.
81
82
83Demo
84====
85
86http://demo.telemeta.org
87
88login: demo
89password: demo
90
91
92Serious Usecases
93=================
94
95* `Sound archives of the French Ethnomusicology Research Center (CREM) and the Musée de l'Homme <http://archives.crem-cnrs.fr>`_ :
96
97 * a 100 year old world database migrated,
98 * more than 5000 geolocated collections,
99 * more than 32000 geolocated items,
100 * more than 11000 sounds included
101 * 700 Go of original ethnic music files accessible through the web.
102 * started in june 2011
103
104* `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>`_ :
105
106 * various musical instruments recorded for research purposes
107 * started in sept. 2012
108
109* `Sound archives Parisson <http://parisson.telemeta.org>`_ :
110
111* `Scaled BIOdiversity (SABIOD) <http://sabiod.telemeta.org>`
112
113* Various electronic sounds and original electronic music produced by Parisson
114
115
116Install
117=======
118
119See `INSTALL.rst <http://github.com/yomguy/Telemeta/blob/master/INSTALL.rst>`_ and `telemeta.org <http://telemeta.org>`_ for more informations.
120
121
122API / Documentation
123====================
124
125* Publications : https://github.com/Parisson/Telemeta-doc
126* API : http://files.parisson.com/doc/telemeta/
127* Player : https://github.com/Parisson/TimeSide/
128* Example : http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/
129
130
131Development
132===========
133
134|travis_dev| |coverage_dev|
135
136.. |travis_dev| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=dev
137   :target: https://travis-ci.org/Parisson/Telemeta/
138   :alt: Travis
139
140.. |coverage_dev| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=dev
141   :target: https://coveralls.io/r/Parisson/Telemeta?branch=dev
142   :alt: Coverage
143
144
145You are welcome to participate to the development of the Telemeta project.
146The official project site is `telemeta.org <http://telemeta.org>`_ but you can find a mirror on `GitHub <https://github.com/Parisson/Telemeta>`_.
147
148To get and run the lastest development version::
149
150    sudo apt-get install git
151    git clone https://github.com/Parisson/Telemeta.git
152    cd Telemeta
153    git checkout dev
154    git submodule foreach git fetch --tags
155    git submodule update --init --recursive
156    sudo pip install -e .
157    export PYTHONPATH=$PYTHONPATH:`pwd`
158
159
160Bugs and feedback
161=================
162
163You are welcome to freely use this application in accordance with its licence.
164If you find some bugs, PLEASE leave a ticket on this page:
165
166https://github.com/Parisson/Telemeta/issues/new
167
168You 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>`_.
169
170And even if Telemeta suits you, please give us some feedback !
171
172
173Contact
174=======
175
176Homepage: http://telemeta.org
177
178E-mails:
179
180 * Guillaume Pellerin <yomguy@parisson.com>,
181 * Thomas Fillon <thomas@parisson.com>
182 * Olivier Guilyardi <olivier@samalyse.com>,
183 * Riccardo Zaccarelli <riccardo.zaccarelli@gmail.com>
184
185Twitter:
186
187 * http://twitter.com/telemeta
188 * http://twitter.com/parisson_studio
189 * http://twitter.com/yomguy
190
191
192License
193=======
194
195CeCILL v2, compatible with GPL v2 (see `LICENSE <http://github.com/yomguy/Telemeta/blob/master/LICENSE>`_)
196
197
198Sponsors
199========
200
201The Telemeta project is developed by Parisson. It is sponsored by :
202
203  * CNRS : Centre National de la Recherche Scientifique (the french Natianal Research and Scientific Center)
204    http://cnrs.fr
205  * CREM : Centre de Recherche en Ethnomusicology (the french Ethnomusicology Research Center)
206    http://www.crem-cnrs.fr
207  * LAM : Equipe Lutherie, Acoustique et Musique de l'Université Pierre et Marie Curie de Paris
208    (Instrument design, Acoustic and Music team of the Pierre & Marie Curie University)
209    http://www.lam.jussieu.fr/
210  * MuCEM : Musée des Civilisations de l'Europe et de la Méditerranée
211    http://www.musee-europemediterranee.org
212  * MMSH : Maison Méditerranéenne des Sciences de l'Homme
213    http://www.mmsh.univ-aix.fr/
214  * MNHN : Museum d'Histoire Naturelle (Paris, France)
215    http://www.mnhn.fr
216
217
Note: See TracBrowser for help on using the repository browser.