Skip to content

Commit

Permalink
v1.1.2 : better setup.py, especially for Windows users
Browse files Browse the repository at this point in the history
  • Loading branch information
Alberto Pettarin committed Sep 24, 2015
1 parent 63e76fe commit 47da67b
Show file tree
Hide file tree
Showing 52 changed files with 317 additions and 124 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
MANIFEST
aeneas/build
bak
build
dist
docs/build
tmp
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

**aeneas** is a Python library and a set of tools to automagically synchronize audio and text.

* Version: 1.1.1
* Date: 2015-08-23
* Version: 1.1.2
* Date: 2015-09-24
* Developed by: [ReadBeyond](http://www.readbeyond.it/)
* Lead Developer: [Alberto Pettarin](http://www.albertopettarin.it/)
* License: the GNU Affero General Public License Version 3 (AGPL v3)
Expand Down Expand Up @@ -86,7 +86,7 @@ for example using [aeneas-vagrant](https://github.com/readbeyond/aeneas-vagrant)
$ git clone https://github.com/readbeyond/aeneas.git
$ cd aeneas
$ pip install -r requirements.txt
$ python setup.py build
$ python setup.py build_ext --inplace
$ python check_dependencies.py
```

Expand All @@ -103,9 +103,12 @@ you can install all the dependencies by running
$ sudo bash install_dependencies.sh
```

Then, run `python setup.py build` and `check_dependencies.py` as above.
Then, run `python setup.py build_ext --inplace` and `python check_dependencies.py` as above.

If you are a Windows user, please read
If you are a Windows user, please read the installation instructions
contained in the
["Using aeneas for Audio-Text Synchronization" PDF](http://software.sil.org/scriptureappbuilder/resources/)
based on
[these directions](https://groups.google.com/d/msg/aeneas-forced-alignment/p9cb1FA0X0I/8phzUgIqBAAJ),
written by Richard Margetts.

Expand All @@ -130,9 +133,8 @@ created by [aeneas-vagrant](https://github.com/readbeyond/aeneas-vagrant).

3. (Optional, but strongly suggested) Compile the Python C extensions:

Linux or Windows:
```bash
$ python setup.py build
$ python setup.py build_ext --inplace
```

4. To compute a SMIL synchronization map `map.smil` for a pair
Expand Down Expand Up @@ -376,5 +378,6 @@ APIs and Web application for ReadBeyond Sync,
helped shaping the structure of this package
for its asynchronous usage.
All the mighty [GitHub contributors](https://github.com/readbeyond/aeneas/graphs/contributors),
and the members of the [Google Group](https://groups.google.com/d/forum/aeneas-forced-alignment).
29 changes: 15 additions & 14 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ aeneas
**aeneas** is a Python library and a set of tools to automagically
synchronize audio and text.

- Version: 1.1.1
- Date: 2015-08-23
- Version: 1.1.2
- Date: 2015-09-24
- Developed by: `ReadBeyond <http://www.readbeyond.it/>`__
- Lead Developer: `Alberto Pettarin <http://www.albertopettarin.it/>`__
- License: the GNU Affero General Public License Version 3 (AGPL v3)
Expand Down Expand Up @@ -96,8 +96,7 @@ Installation
$ git clone https://github.com/readbeyond/aeneas.git
$ cd aeneas
$ pip install -r requirements.txt
$ bash compile_c_extensions.sh
(On Windows: $ compile_c_extensions.bat )
$ python setup.py build_ext --inplace
$ python check_dependencies.py

If the last command prints a success message, you have all the required
Expand All @@ -112,10 +111,13 @@ Ubuntu), you can install all the dependencies by running `the provided

$ sudo bash install_dependencies.sh

Then, run ``compile_c_extensions.sh`` and ``check_dependencies.py`` as
above.
Then, run ``python setup.py build_ext --inplace`` and
``python check_dependencies.py`` as above.

If you are a Windows user, please read `these
If you are a Windows user, please read the installation instructions
contained in the `"Using aeneas for Audio-Text Synchronization"
PDF <http://software.sil.org/scriptureappbuilder/resources/>`__ based on
`these
directions <https://groups.google.com/d/msg/aeneas-forced-alignment/p9cb1FA0X0I/8phzUgIqBAAJ>`__,
written by Richard Margetts.

Expand All @@ -142,13 +144,7 @@ Usage

.. code:: bash

$ bash compile_c_extensions.sh

or, on Windows:

.. code:: bash

$ compile_c_extensions.bat
$ python setup.py build_ext --inplace

4. To compute a SMIL synchronization map ``map.smil`` for a pair
(``audio.mp3``, ``text.txt``), you can run:
Expand Down Expand Up @@ -394,3 +390,8 @@ text.
**Paolo Bertasi**, who developed the APIs and Web application for
ReadBeyond Sync, helped shaping the structure of this package for its
asynchronous usage.

All the mighty `GitHub
contributors <https://github.com/readbeyond/aeneas/graphs/contributors>`__,
and the members of the `Google
Group <https://groups.google.com/d/forum/aeneas-forced-alignment>`__.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.1
1.1.2
2 changes: 1 addition & 1 deletion aeneas/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/adjustboundaryalgorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/analyzecontainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/audiofile.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/cdtw.c
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ __copyright__ = """
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"
Expand Down
42 changes: 41 additions & 1 deletion aeneas/cdtw_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,44 @@
.. versionadded:: 1.1.0
"""

print 'Deprecated. Use "python setup.py build" in the main directory'
import os
import sys

from distutils.core import setup, Extension
from numpy.distutils import misc_util

__author__ = "Alberto Pettarin"
__copyright__ = """
Copyright 2012-2013, Alberto Pettarin (www.albertopettarin.it)
Copyright 2013-2015, ReadBeyond Srl (www.readbeyond.it)
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

for compiled in ["cdtw.so", "cdtw.dylib", "cdtw.dll"]:
if os.path.exists(compiled):
try:
os.remove(compiled)
print "[INFO] Removed file %s\n" % compiled
except:
pass

CMODULE = Extension("cdtw", sources=["cdtw.c"])

setup(
name="cdtw",
version="1.1.1",
description="""
Python C Extension for computing the DTW as fast as your bare metal allows.
""",
ext_modules=[CMODULE],
include_dirs=misc_util.get_numpy_include_dirs()
)

print "\n[INFO] Module cdtw successfully compiled\n"
sys.exit(0)


2 changes: 1 addition & 1 deletion aeneas/cmfcc.c
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ __copyright__ = """
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"
Expand Down
42 changes: 41 additions & 1 deletion aeneas/cmfcc_setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,44 @@
.. versionadded:: 1.1.0
"""

print 'Deprecated. Use "python setup.py build" in the main directory'
import os
import sys

from distutils.core import setup, Extension
from numpy.distutils import misc_util

__author__ = "Alberto Pettarin"
__copyright__ = """
Copyright 2012-2013, Alberto Pettarin (www.albertopettarin.it)
Copyright 2013-2015, ReadBeyond Srl (www.readbeyond.it)
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

for compiled in ["cmfcc.so", "cmfcc.dylib", "cmfcc.dll"]:
if os.path.exists(compiled):
try:
os.remove(compiled)
print "[INFO] Removed file %s\n" % compiled
except:
pass

CMODULE = Extension("cmfcc", sources=["cmfcc.c"])

setup(
name="cmfcc",
version="1.1.1",
description="""
Python C Extension for computing the MFCCs as fast as your bare metal allows.
""",
ext_modules=[CMODULE],
include_dirs=misc_util.get_numpy_include_dirs()
)

print "\n[INFO] Module cmfcc successfully compiled\n"
sys.exit(0)


2 changes: 1 addition & 1 deletion aeneas/container.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/dtw.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/espeakwrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/executejob.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/executetask.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/ffmpegwrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/ffprobewrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/globalconstants.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/globalfunctions.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/hierarchytype.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/idsortingalgorithm.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/job.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
2 changes: 1 addition & 1 deletion aeneas/language.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
Copyright 2015, Alberto Pettarin (www.albertopettarin.it)
"""
__license__ = "GNU AGPL v3"
__version__ = "1.1.1"
__version__ = "1.1.2"
__email__ = "[email protected]"
__status__ = "Production"

Expand Down
Loading

0 comments on commit 47da67b

Please sign in to comment.