Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

add README and LICENCE

  • Loading branch information...
commit 8f444c760f6ab1d1080d03ca296441ef064abbcd 1 parent 03bfd61
Brecht Machiels authored
Showing with 79 additions and 0 deletions.
  1. +26 −0 LICENSE
  2. +53 −0 README.md
26 LICENSE
View
@@ -0,0 +1,26 @@
+Copyright 2011-2012 Brecht Machiels. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies,
+either expressed or implied, of the copyright holder.
53 README.md
View
@@ -0,0 +1,53 @@
+citeproc-py
+===========
+
+citeproc-py is a CSL processor written in Python. It aims to implement CSL 1.0,
+but already supports some CSL 1.0.1 features.
+
+It has been developed using Python 3 and currently doesn't run under Python 2.x.
+It shouldn't be too hard to get it to work in Python 2 though (3to2?). In
+addition, citeproc-py depends on [lxml](http://lxml.de/) for parsing and
+navigating the CSL styles and locale files.
+
+citeproc-py has basic, incomplete support for loading reference data from a
+BibTeX file.
+
+CSL Compatibility
+-----------------
+
+Currently, citeproc-py passes almost 60% of the (relevant) tests in the
+[citeproc-test suite](https://bitbucket.org/bdarcus/citeproc-test). However, it
+is more than 60% complete, as citeproc-py doesn't take care of double spaces and
+repeated punctuation marks yet, making a good deal of the tests fail. In
+addition, the following features have not yet been implemented (there are
+probably some I forgot though):
+
+* disambiguation/year-suffix
+* et-al-subsequent-min/et-al-subsequent-use-first
+* position
+* collapsing
+* punctuation-in-quote
+* page-range-format
+* display
+* text-case (incomplete)
+* seasons
+
+Also, some [citeproc-js](http://bitbucket.org/fbennett/citeproc-js/wiki/Home)
+functionality that is not part of the CSL spec is not (yet) supported:
+* raw dates
+* static-ordering
+* literal names
+
+
+Running the Tests
+-----------------
+
+First clone the
+[citeproc-test suite](https://bitbucket.org/bdarcus/citeproc-test) so that it
+sits next to the citeproc-py directory. Then run the `processor.py` script to
+generate the test fixtures (using Python 2.x). After that, you can run
+`citeproc-test.py` (in the `tests` directory). Run `citeproc-test.py --help` to
+see its usage information.
+
+
+Brecht Machiels
Please sign in to comment.
Something went wrong with that request. Please try again.