diff --git a/LICENSE.txt b/LICENSE.txt index 7e85f5a..3825db2 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,5 +1,63 @@ pyRdfa is released under the W3C© SOFTWARE NOTICE AND LICENSE, see: -http://href="http//www.w3.org/Consortium/Legal/2002/copyright-software-20021231%22 +https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document -for further details +W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE +Status: This license takes effect 13 May, 2015. + +This work is being provided by the copyright holders under the following +license. + +License + +By obtaining and/or copying this work, you (the licensee) agree that you +have read, understood, and will comply with the following terms and +conditions. + +Permission to copy, modify, and distribute this work, with or without +modification, for any purpose and without fee or royalty is hereby +granted, provided that you include the following on ALL copies of the +work or portions thereof, including modifications: + +The full text of this NOTICE in a location viewable to users of the +redistributed or derivative work. + +Any pre-existing intellectual property disclaimers, notices, or terms +and conditions. If none exist, the W3C Software and Document Short +Notice should be included. + +Notice of any changes or modifications, through a copyright statement on +the new code or document such as "This software or document includes +material copied from or derived from [title and URI of the W3C +document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)." + +Disclaimers + +THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO +REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT +LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR +PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE +ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. + +COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL +OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR +DOCUMENT. + +The name and trademarks of copyright holders may NOT be used in +advertising or publicity pertaining to the work without specific, +written prior permission. Title to copyright in this work will at all +times remain with copyright holders. + +Notes + +This version: +http://www.w3.org/Consortium/Legal/2015/copyright-software-and-document + +Previous version: +http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 + +This version makes clear that the license is applicable to both software +and text, by changing the name and substituting "work" for instances of +"software and its documentation." It moves "notice of changes or +modifications to the files" to the copyright notice, to make clear that +the license is compatible with other liberal licenses. diff --git a/README.md b/README.md deleted file mode 100644 index 744e653..0000000 --- a/README.md +++ /dev/null @@ -1,51 +0,0 @@ -[![DOI](https://zenodo.org/badge/9385/RDFLib/pymicrodata.svg)](http://dx.doi.org/10.5281/zenodo.14541) - - - -pyMicrodata distiller/parser library. The distribution contains: - -- ./pyMicrodata: the Python library. You should copy the directory - somewhere into your PYTHONPATH. Alternatively, you can also run the - - python setup.py install - - script in the directory. - -- ./scripts/CGI_microdata.py: can be used as a CGI script to invoke the library. - It has to be adapted to the local server setup, namely in setting the right paths - -- ./scripts/localMicrodata.py: script that can be run locally on to transform - a file into RDF (on the standard output). Run the script with "-h" to - get the available flags. - -- ./Doc-pyMicrodata: (epydoc) documentation of the classes and functions - -- ./generatePyMicrodataDoc: a shell script to generate the documentation (using epydoc) - -- ./epydoc.css: the CSS file the documentation generation uses (it is then copied to the documentation area itself) - -The package primarily depends on: - - RDFLib. Version 3.2.0 or higher is strongly recommended. - - html5lib (in the additional packages folder) - - several details or simply a more complete serialization depends on the pyrdfa3 package on github: https://github.com/RDFLib/pyrdfa3. Although the basic RDF conversion works without this, some serializations may not be available and the vocabulary expansion mechanism would not work either. - -The package has been tested on Python version 2.4 and higher. Python 2.7 is strongly recommended. The package has been adapted to Python 3, though not yet thoroughly tested, because html5lib does not have yet a Python 3 version. - -For the details on the conversion of Microdata to RDF, see: - -http://www.w3.org/TR/2014/NOTE-microdata-rdf-201412XX/ - - -Release notes (starting from version 1.0) -========================================= - -- this is the first fully released version - -- Version 2.0: adapted to the new version of the microdata->RDF note. Differences, and its effect on the code, are: - - The content of the registry is greatly reduced, see Appendix C - - Remove the vocab expansion flag (although probably wise to keep it on the top, entry level, and just remove it - from the real processing, to avoid backward compatibility issues for deployed code - - - - diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..84c7347 --- /dev/null +++ b/README.rst @@ -0,0 +1,74 @@ + +============== +pyMicrodata +============== + +.. image:: https://zenodo.org/badge/9385/RDFLib/pymicrodata.svg + :target: http://dx.doi.org/10.5281/zenodo.14541 + + +pyMicrodata distiller/parser library. The distribution contains: + +- ``./pyMicrodata``: the Python library. You should copy the directory + somewhere into your PYTHONPATH. Alternatively, you can also run: + + .. code:: bash + + python setup.py install + + +- ``./scripts/CGI_microdata.py``: can be used as a CGI script to invoke + the library. It has to be adapted to the local server setup, namely + in setting the right paths + +- ``./scripts/localMicrodata.py``: script that can be run locally on to + transform a file into RDF (on the standard output). Run the script + with "-h" to get the available flags. + +- ``./Doc-pyMicrodata``: (epydoc) documentation of the classes and functions + +- ``./generatePyMicrodataDoc``: a shell script to generate the + documentation (using epydoc) + +- ``./epydoc.css``: the CSS file the documentation generation uses (it + is then copied to the documentation area itself) + +The package primarily depends on: + +- `RDFLib `_ version 3.2.0 or higher is strongly + recommended. +- `html5lib `_ (in the additional + packages folder) +- several details or simply a more complete serialization depends on + the pyrdfa3 package on github: https://github.com/RDFLib/pyrdfa3. + Although the basic RDF conversion works without this, some + serializations may not be available and the vocabulary expansion + mechanism would not work either. + +The package has been tested on Python version 2.4 and higher. Python 2.7 +is strongly recommended. The package has been adapted to Python 3, +though not yet thoroughly tested, because html5lib does not have yet a +Python 3 version. + +For the details on the conversion of Microdata to RDF, see: + +http://www.w3.org/TR/2014/NOTE-microdata-rdf-201412XX/ + + +Release notes (starting from version 1.0) +========================================= + +- this is the first fully released version + +- Version 2.0: adapted to the new version of the microdata->RDF note. + Differences, and its effect on the code, are: + + - The content of the registry is greatly reduced, see Appendix C + - Remove the vocab expansion flag (although probably wise to keep it + on the top, entry level, and just remove it from the real + processing, to avoid backward compatibility issues for deployed + code + + + + diff --git a/setup.py b/setup.py index 2d03414..2ba8420 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,21 @@ -from distutils.core import setup + +import os +import codecs +from setuptools import setup + +HERE = os.path.dirname(__file__) +README = os.path.join(HERE, 'README.rst') +with codecs.open(README, 'r', encoding='utf8') as f: + LONG_DESCRIPTION = f.read() + setup(name="pyMicrodata", - description="pyMicrodata Libray", + description=LONG_DESCRIPTION, version="2.0", author="Ivan Herman", author_email="ivan@w3.org", maintainer="Ivan Herman", maintainer_email="ivan@w3.org", + url='https://github.com/RDFLib/pymicrodata', packages=['pyMicrodata'], - requires = ['rdflib']) + install_requires = ['rdflib'])