python/: move generator.py to lib, improve README, remove env_ files, update MANIFEST.in
authorPaul Brossier <piem@piem.org>
Fri, 8 Mar 2013 14:30:45 +0000 (09:30 -0500)
committerPaul Brossier <piem@piem.org>
Fri, 8 Mar 2013 14:30:45 +0000 (09:30 -0500)
python/MANIFEST.in
python/README
python/env_linux [deleted file]
python/env_osx [deleted file]
python/lib/__init__.py [new file with mode: 0644]
python/lib/gen_pyobject.py [moved from python/gen_pyobject.py with 100% similarity]
python/lib/generator.py [moved from python/generator.py with 100% similarity]
python/setup.py

index 93ba39749d3f8911e6cdd692a322fdd49a78f295..cffccebff23ae4188e983339173da06369a97406 100644 (file)
@@ -1,9 +1,8 @@
 include README COPYING VERSION
 include ext/*.h
+include lib/generator.py
+include lib/gen_pyobject.py
 include gen/aubio-generated.h
-include generator.py
-include gen_pyobject.py
-include aubio/*.py
-include demos/*.py
 include tests/run_all_tests
 include tests/*.py
+include demos/*.py
index 4103c8bc98ee35ac01cb14b40841af457912be74..537f48482f3c2c7f77ce5141e71627e082a33058 100644 (file)
@@ -12,10 +12,27 @@ Compiling python aubio
 
 You should be able to build the aubio python module out of the box:
 
-    $ ./build_osx
+    $ python setup.py build
 
-This should work on linux based systems as well as recent versions of OS X
-(10.8.x). Let me know if you have issues on your platforms.
+To use the python module without installing it, set PYTHONPATH:
+
+    $ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests
+
+And LD_LIBRARY_PATH:
+
+    $ export LD_LIBRARY_PATH=$PWD/../build/src
+
+Or on macosx systems:
+
+    $ export DYLD_LIBRARY_PATH=$PWD/../build/src
+
+The you should be able to run the tests:
+
+    $ ./tests/run_all_tests
+
+And to try out the demos:
+
+    $ ./demos/demo_source.wav ~/test.wav
 
 Additional tools
 ----------------
diff --git a/python/env_linux b/python/env_linux
deleted file mode 100755 (executable)
index adffa76..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-#! /bin/sh
-
-export PYTHONPATH=$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests:$PYTHONPATH
-export LD_LIBRARY_PATH=$PWD/../build/src
diff --git a/python/env_osx b/python/env_osx
deleted file mode 100755 (executable)
index aa27f7e..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-#! /bin/sh
-
-export PYTHONPATH=$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests:$PYTHONPATH
-export DYLD_LIBRARY_PATH=$PWD/../build/src
diff --git a/python/lib/__init__.py b/python/lib/__init__.py
new file mode 100644 (file)
index 0000000..e69de29
similarity index 100%
rename from python/generator.py
rename to python/lib/generator.py
index c7cef374f3a68bddea5322bff563163cc125bc0e..23a4f4a2fc5133923bdc99459b72cdcc12142e12 100755 (executable)
@@ -28,7 +28,7 @@ output_path = 'gen'
 generated_object_files = []
 
 if not os.path.isdir(output_path):
-    from generator import generate_object_files
+    from lib.generator import generate_object_files
     generated_object_files = generate_object_files(output_path)
     # define include dirs
 else: