Permalink
Browse files

Got distutils in order.

  • Loading branch information...
jacobjoaquin committed Jul 23, 2009
1 parent 2ad9c69 commit 5f70f4f4b71c63e0ea343b5dda7fbb33cc53f44f
View
@@ -6,3 +6,71 @@ csd/sco/__init__.py
csd/sco/element/__init__.py
csd/sco/event/__init__.py
csd/sco/selection/__init__.py
+demo/arpeggiator.py
+demo/arpeggiator.sco
+demo/carry.py
+demo/carry.sco
+demo/foo.py
+demo/pfunc.py
+demo/pfunc.sco
+demo/s_spacer.py
+demo/s_spacer.sco
+demo/sco_align.py
+demo/sco_align.sco
+demo/score_from_csd.csd
+demo/score_from_csd.py
+demo/swap_columns.py
+demo/swap_columns.sco
+demo/swap_pan_position.sco
+docs/.buildinfo
+docs/bugs.html
+docs/commandline.html
+docs/csd_sco_event.html
+docs/genindex.html
+docs/glossary.html
+docs/index.html
+docs/modindex.html
+docs/objects.inv
+docs/search.html
+docs/searchindex.js
+docs/_sources/bugs.txt
+docs/_sources/commandline.txt
+docs/_sources/csd_sco_event.txt
+docs/_sources/glossary.txt
+docs/_sources/index.txt
+docs/_sources/demo/index.txt
+docs/_static/basic.css
+docs/_static/default.css
+docs/_static/doctools.js
+docs/_static/file.png
+docs/_static/jquery.js
+docs/_static/minus.png
+docs/_static/plus.png
+docs/_static/pygments.css
+docs/_static/searchtools.js
+docs/demo/index.html
+tests/csd.sco.element.is_valid.py
+tests/csd.sco.element.is_valid_pfield.py
+tests/csd.sco.element.token_type.py
+tests/csd.sco.event.get.py
+tests/csd.sco.event.get_pfield_list.py
+tests/csd.sco.event.get_trailing_comment.py
+tests/csd.sco.event.insert.py
+tests/csd.sco.event.match.py
+tests/csd.sco.event.number_of_pfields.py
+tests/csd.sco.event.pop.py
+tests/csd.sco.event.push.py
+tests/csd.sco.event.remove.py
+tests/csd.sco.event.sanitize.py
+tests/csd.sco.event.set.py
+tests/csd.sco.event.split.py
+tests/csd.sco.event.statement_spacer.py
+tests/csd.sco.event.swap.py
+tests/csd.sco.event.tokenize.py
+tests/csd.sco.map_.py
+tests/csd.sco.merge.py
+tests/csd.sco.select.py
+tests/csd.sco.select_all.py
+tests/csd.sco.selection.operate_numeric.py
+tests/csd.sco.selection.replace.py
+tests/csd.sco.selection.swap.py
View
@@ -0,0 +1,3 @@
+include demo/*.py demo/*.sco demo/*.csd demo/*.orc
+include tests/*.py
+recursive-include docs *
View
@@ -34,6 +34,11 @@ html:
@echo
@echo "Build finished. The HTML pages are in build/html."
+html_docs:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) ../docs
+ @echo
+ @echo "Build finished. The HTML pages are in docs/."
+
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
@echo
Binary file not shown.
Binary file not shown.
@@ -160,7 +160,7 @@
#html_file_suffix = ''
# Output file base name for HTML help builder.
-htmlhelp_basename = 'scoparsedoc'
+htmlhelp_basename = 'csd'
# -- Options for LaTeX output --------------------------------------------------
@@ -174,7 +174,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'scoparse.tex', u'scoparse Documentation',
+ ('index', 'csd.tex', u'csd Documentation',
u'Jacob Joaquin', 'manual'),
]
View
Binary file not shown.
View
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ae7f6641b04fca639aeeac756a41c814
+tags: fbb0d17656682115ca4d033fb2f83ba1
View
@@ -0,0 +1,44 @@
+Bugs
+=====
+
+* In some of the test scores, there are some score string examples using
+ single quotes. Single quotes are not supported by the score.
+
+* Test-cases need to be written for demos.
+
+* Jython 2.5 fails some tests.
+
+* The python interpreter didn't like passing a selection generated with
+ csd.sco.select_all() to csd.sco.operate_numeric().
+
+Planned Changes
+===============
+
+* Error checking, exceptions, and warnings - *Oh my!!*
+* Need to get an online repository. At least a somewhat official site.
+* Need to make auto-installation happen. Eggs?
+* Tutorials on how to build custom scripts using this package.
+* Spell check docs.
+* Elements become atoms?
+* Need a better name than pf_function.
+* Need to use better names for pfield and pfield_list, as some of the
+ terms currently trip over each other. pfield, pfield_index,
+ pfield_index_list, etc...
+* When dealing with dicts, make sure they are sorted. Had an issue with
+ csd.sco.operate_numeric().
+* selection functions needs a contracterual flow.
+
+ When a function receives a selection, a value in a key_index may
+ contain multiple lines, and thus, the receiving function must
+ operate on it.
+
+ The value should be treated as a value_score. A string containing
+ one or more events. Thus, it should be split.
+
+ After the split, it can be processed.
+
+ Before replacing the orignal value_score, the split needs to be
+ joined, creating a single string, with newlines as evenet
+ delimiters.
+
+
@@ -0,0 +1,46 @@
+Command-line Operations
+=======================
+
+Pasteboard Trick (for OS X)
+---------------------------
+
+OS X comes with two commands that can easily aid in the process of
+using these demo scripts in your work flow: ``pbpaste`` and ``pbcopy``.
+These paste and copy the contents of the pasteboard in the OS X
+Terminal.
+
+To use in a workflow, highlight a section of score you want to process,
+copy the selection, type the following into the Terminal::
+
+ $ pbpaste | ./align.py | pbcopy
+
+Go back to your text editor, and with the section of score code still
+highlighted, paste. The highlighted test will be replaced with your
+newly processed score.
+
+Pipe Chain Trick
+----------------
+
+It is possible to chain pipes in series to process scores with
+multiple scripts in one swoop. The following command does two things.
+First, it sums the values of pfields 4 in instrument 2 events with
+0.99999 with sum.py. The output is then piped into align.py, making
+the columns tidy and neat::
+
+ $ cat arpeggiator.sco | ./arpeggiator.py -si -i1 -p4 -v'0.1 0.444 0.9922' | ./sco_align.py
+
+
+.. highlight:: none
+
+Arpeggiated and aligned::
+
+ i 1 0 0.25 0.1 7.00
+ i 1 + . 0.444 .
+ i 1 + . 0.9922 .
+ i 1 + . 0.1 .
+ i 1 + . 0.444 .
+ i 1 + . 0.9922 .
+ i 1 + . 0.1 .
+ i 1 + . 0.444 .
+
+
@@ -0,0 +1,38 @@
+###############
+The csd Package
+###############
+
+csd
+---
+
+.. automodule:: csd
+ :members:
+
+sco
+---
+
+.. automodule:: csd.sco
+ :members:
+
+event
+-----
+
+The event module parses single score events. In almost all cases,
+when you are parsing an event, you are dealing with score elements,
+such as pfield data, comments and whitespace.
+
+.. automodule:: csd.sco.event
+ :members:
+
+element
+-------
+
+.. automodule:: csd.sco.element
+ :members:
+
+selection
+---------
+
+.. automodule:: csd.sco.selection
+ :members:
+
@@ -0,0 +1,56 @@
+#####
+Demos
+#####
+
+These are examples of what can be built with the score module.
+
+Demo scripts are located in ``/demo/``.
+
+.. note:: Demos have only been tested using Apple's
+ Python 2.5.1. Further testing will need to be done in other
+ versions of Python.
+
+.. warning:: These are to be considered unstable releases until they
+ are properly tested and bug checked.
+
+arpeggiator
+-----------
+
+.. automodule:: arpeggiator
+ :members:
+
+carry
+-----
+
+.. automodule:: carry
+ :members:
+
+pfunc
+-----
+
+.. automodule:: pfunc
+ :members:
+
+s_spacer
+---------------
+
+.. automodule:: s_spacer
+ :members:
+
+sco_align
+---------
+
+.. automodule:: sco_align
+ :members:
+
+score_from_csd
+--------------
+.. automodule:: score_from_csd
+ :members:
+
+swap_columns
+------------
+
+.. automodule:: swap_columns
+ :members:
+
Oops, something went wrong.

0 comments on commit 5f70f4f

Please sign in to comment.