Skip to content

Commit

Permalink
Bump version and move to using rst for the README
Browse files Browse the repository at this point in the history
chrisburr committed Feb 11, 2018
1 parent 64bd3f4 commit 3c73bc8
Showing 3 changed files with 56 additions and 12 deletions.
11 changes: 0 additions & 11 deletions README.md

This file was deleted.

55 changes: 55 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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 <https://root.cern.ch/doc/master/classTFormula.html>`__ and
`numexpr <https://numexpr.readthedocs.io/en/latest/user_guide.html>`__
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**
2 changes: 1 addition & 1 deletion formulate/version.py
Original file line number Diff line number Diff line change
@@ -11,6 +11,6 @@
]


__version__ = "0.0.2"
__version__ = "0.0.3"
version = __version__
version_info = __version__.split('.')

0 comments on commit 3c73bc8

Please sign in to comment.