diff --git a/README.md b/README.md deleted file mode 100644 index 06e40fd..0000000 --- a/README.md +++ /dev/null @@ -1,11 +0,0 @@ -:construction: **Formulate is currently under construction and not yet ready for production use! Expect things to break!** :construction: - -# Formulate - -[![Build Status](https://travis-ci.org/chrisburr/formulate.svg?branch=master)](https://travis-ci.org/chrisburr/formulate) -[![Coverage Status](https://coveralls.io/repos/github/chrisburr/formulate/badge.svg?branch=master)](https://coveralls.io/github/chrisburr/formulate?branch=master) -[![PyPI](https://badge.fury.io/py/formulate.svg)](https://pypi.python.org/pypi/formulate/) - -Easy conversions between different styles of expressions. Formulate currently -supports converting between [`ROOT`](https://root.cern.ch/doc/master/classTFormula.html) -and [`numexpr`](https://numexpr.readthedocs.io/en/latest/user_guide.html) style expressions. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..902c36c --- /dev/null +++ b/README.rst @@ -0,0 +1,55 @@ +🚧 **Formulate is currently under construction and not yet +ready for production use! Expect things to break!** 🚧 + +Formulate +========= + +|Build Status| |Coverage Status| |PyPI| + +Easy conversions between different styles of expressions. Formulate +currently supports converting between +`ROOT `__ and +`numexpr `__ +style expressions. + +.. |Build Status| image:: https://travis-ci.org/chrisburr/formulate.svg?branch=master + :target: https://travis-ci.org/chrisburr/formulate +.. |Coverage Status| image:: https://coveralls.io/repos/github/chrisburr/formulate/badge.svg?branch=master + :target: https://coveralls.io/github/chrisburr/formulate?branch=master +.. |PyPI| image:: https://badge.fury.io/py/formulate.svg + :target: https://pypi.python.org/pypi/formulate/ + + +Installation +------------ + +Install formulate like any other Python package: + +.. code-block:: bash + + pip install --user formulate + +or similar (use ``sudo``, ``virtualenv``, or ``conda`` if you wish). + + +Usage +----- + +Command line usage +"""""""""""""""""" + +.. code-block:: bash + + $ python -m formulate --from-root '(A && B) || TMath::Sqrt(A)' --to-numexpr + (A & B) | sqrt(A) + +API +""" + +**TODO** + + +The `Expression` Object +----------------------- + +**TODO** diff --git a/formulate/version.py b/formulate/version.py index b9e238a..47ca5e1 100644 --- a/formulate/version.py +++ b/formulate/version.py @@ -11,6 +11,6 @@ ] -__version__ = "0.0.2" +__version__ = "0.0.3" version = __version__ version_info = __version__.split('.')