Metadata-Version: 2.0
Name: algebraixlib
Version: 1.0
Summary: A data algebra library
Home-page: https://github.com/AlgebraixData/algebraixlib
Author: Algebraix Data Corporation
Author-email: algebraixlib@algebraixdata.com
License: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
Keywords: data algebra set theory
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: rdflib (>=4.2)

.. Algebraix Technology Core Library documentation.
   $Id: README.rst 22624 2015-07-15 21:35:12Z wholler $
   Copyright Algebraix Data Corporation 2015 - $Date: 2015-07-15 16:35:12 -0500 (Wed, 15 Jul 2015) $

   This file is part of algebraixlib <http://github.com/AlgebraixData/algebraixlib>.

   algebraixlib is free software: you can redistribute it and/or modify it under the terms of
   version 3 of the GNU Lesser General Public License as published by the Free Software Foundation.

   algebraixlib is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
   even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License along with algebraixlib.
   If not, see <http://www.gnu.org/licenses/>.

algebraixlib
============

What Is It?
-----------
``algebraixlib`` is a library that provides constructs and facilities to harness the fundamentals
of data algebra.

Requirements
------------
Python 3.4.3 or later.

How to Install
--------------
If you already have Python installed and are familiar with installing packages, you can get
``algebraixlib`` with ``pip``::

> pip install algebraixlib

You can also manually download ``algebraixlib`` from `GitHub`_ or `PyPI`_. To install from a
download, unpack it and run the following from the top-level source directory using the terminal::

> python setup.py install

Unit Tests
----------
The unit tests require the following libraries be installed:

* coverage
* nose

To execute the unit tests, from the console, in the algebraixlib directory, use the command::

> python runtests.py

Document Build
--------------
The document builds require the following libraries be installed:

* Sphinx (1.3 or later)

To execute the document builds, from the console, in the algebraixlib/docs directory, use command::

> python build.py

Documentation and Support
-------------------------

* Find documentation at `Read the Docs`_.
* Find the library on `PyPI`_.
* Find the library on `GitHub`_.
* Find the IPython notebooks at `Wakari.io`_.
* Post questions about algebraixlib on `Stack Overflow`_ using the tag [algebraixlib].
* Post questions about the mathematics of data algebra on `math.stackexchange`_ using the tag [data-algebra].
* Contact us at `email`_

There is also a book forthcoming about data algebra.

Copyright
---------
Copyright(c) 2015 Algebraix Data Corporation.

License
-------
``algebraixlib`` is free software: you can redistribute it and/or modify it under the terms of
`version 3 of the GNU Lesser General Public License`_ as published by the
`Free Software Foundation`_. A copy of the GNU Lesser General Public License is published along
with ``algebraixlib`` on `GitHub`_. Otherwise, see `GNU licenses`_.

Warranty
--------
``algebraixlib`` is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.


.. _email:
    mailto:algebraixlib@algebraixdata.com
.. _Read the Docs:
    http://algebraixlib.rtfd.org/
.. _PyPI:
    http://pypi.python.org/pypi/algebraixlib
.. _GitHub:
    http://github.com/AlgebraixData/algebraixlib
.. _Wakari.io:
    https://wakari.io/sharing/bundle/AlgebraixData/algebraixlib
.. _Stack Overflow:
    http://stackoverflow.com/
.. _math.stackexchange:
    http://math.stackexchange.com/
.. _Version 3 of the GNU Lesser General Public License:
    http://www.gnu.org/licenses/lgpl-3.0-standalone.html
.. _GNU Licenses:
    http://www.gnu.org/licenses/
.. _Free Software Foundation:
    http://www.fsf.org/


