Skip to content

Commit

Permalink
bumped version to 0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
adriank committed Nov 26, 2018
1 parent 743e4b6 commit 8e6bec6
Show file tree
Hide file tree
Showing 3 changed files with 170 additions and 61 deletions.
117 changes: 57 additions & 60 deletions README.rst
@@ -1,12 +1,7 @@
ObjectPath
==========

`|Downloads| <https://pypi.python.org/pypi/objectpath/>`_
`|License| <https://pypi.python.org/pypi/objectpath/>`_ `|Build
Status| <https://travis-ci.org/adriank/ObjectPath>`_ `|Code
Health| <https://landscape.io/github/adriank/ObjectPath/master>`_
`|Coverage
Status| <https://coveralls.io/r/adriank/ObjectPath?branch=master>`_
|Downloads| |Build Status| |Code Health| |Coverage Status|

The agile NoSQL query language for semi-structured data
-------------------------------------------------------
Expand All @@ -23,10 +18,9 @@ system and string concatenation available. On top of that, the language
implementations (Python at the moment; Javascript is in beta!) are
secure and relatively fast.

More at `ObjectPath site <http://objectpath.org/>`_
More at `ObjectPath site <http://objectpath.org/>`__

.. figure:: http://adriank.github.io/ObjectPath/img/op-colors.png
:align: center
:alt: ObjectPath img

ObjectPath img
Expand All @@ -36,80 +30,83 @@ borrows the best parts from E4X, JSONPath, XPath and SQL. ObjectPath is
to JSON documents what XPath is to XML. Other examples to ilustrate this
kind of relationship are:

============== ==================
Scope Language
============== ==================
text documents regular expression
XML XPath
HTML CSS selectors
JSON documents ObjectPath
============== ==================
============== ==================
Scope Language
============== ==================
text documents regular expression
XML XPath
HTML CSS selectors
JSON documents ObjectPath
============== ==================

Documentation
-------------

`ObjectPath Reference <http://objectpath.org/reference.html>`_
`ObjectPath Reference <http://objectpath.org/reference.html>`__

What's in this repo?
--------------------
Command line usage
------------------

ObjectPathPY - Python implementation of ObjectPath, used in production
for over two years without problems. Use objectpath.py file as a example
of usage.
.. code:: sh
ObjectPathJS - beta version of Javascript implementation. Many tests
passed, {} and functions are not implemented yet. Javascript
implementation has the very same API as the Python version.
$ sudo pip install objectpath
$ objectpath file.json
Command line usage
------------------
or

.. code:: sh
``sh $ sudo pip install objectpath $ objectpath file.json`` or
``sh $ git clone https://github.com/adriank/ObjectPath.git $ cd ObjectPath $ python shell.py file.json``
$ git clone https://github.com/adriank/ObjectPath.git
$ cd ObjectPath
$ python shell.py file.json
Python usage
------------

::
.. code:: sh
$ sudo pip install objectpath
$ python
>>> from objectpath import *
>>> tree=Tree({"a":1})
>>> tree.execute("$.a")
1
>>>
$ sudo pip install objectpath
$ python
>>> from objectpath import *
>>> tree=Tree({"a":1})
>>> tree.execute("$.a")
1
>>>
::
.. code:: sh
$ git clone https://github.com/adriank/ObjectPath.git
$ cd ObjectPath
$ python
>>> from objectpath import *
>>> tree=Tree({"a":1})
>>> tree.execute("$.a")
1
>>>
$ git clone https://github.com/adriank/ObjectPath.git
$ cd ObjectPath
$ python
>>> from objectpath import *
>>> tree=Tree({"a":1})
>>> tree.execute("$.a")
1
>>>
License
-------
Contributing & bugs
-------------------

**AGPLv3**
I appreciate all contributions and bugfix requests for ObjectPath,
however since I don’t code in Python any more, this library is not
maintained as of now. Since I can’t fully assure that code contributed
by others meets quality standards, I can’t accept PRs.

Using ObjectPath language in your project does not mean that your
project is a derivative work, provided that you don't - extend the
language functionality, - make optimizations, - sub-class any of it's
modules.
If you feel you could maintain this code, ping me. I’d be more than
happy to transfer this repo to a dedicated ObjectPath organization on
GitHub and give the ownership to someone with more time for this project
than me.

AGPL v3 license has been chosen to ensure language consistency and
provide a way to finance its development.
License
-------

**If AGPL v3 is too restrictive for you, please consider buying a
commercial licenses provided by Asyncode. This is the preferred way of
supporting this project financially.**
**MIT**

.. |Downloads| image:: https://pypip.in/download/objectpath/badge.svg
.. |License| image:: https://pypip.in/license/objectpath/badge.svg
.. |Downloads| image:: https://img.shields.io/pypi/dm/objectpath.svg
:target: https://pypi.python.org/pypi/objectpath/
.. |Build Status| image:: https://travis-ci.org/adriank/ObjectPath.svg?branch=master
:target: https://travis-ci.org/adriank/ObjectPath
.. |Code Health| image:: https://landscape.io/github/adriank/ObjectPath/master/landscape.png
:target: https://landscape.io/github/adriank/ObjectPath/master
.. |Coverage Status| image:: https://coveralls.io/repos/adriank/ObjectPath/badge.png?branch=master
:target: https://coveralls.io/r/adriank/ObjectPath?branch=master
112 changes: 112 additions & 0 deletions README.rst.original
@@ -0,0 +1,112 @@
ObjectPath
==========

|Downloads| |Build Status| |Code Health| |Coverage Status|

The agile NoSQL query language for semi-structured data
-------------------------------------------------------

**#Python #NoSQL #Javascript #JSON #nested-array-object**

ObjectPath is a query language similar to XPath or JSONPath, but much
more powerful thanks to embedded arithmetic calculations, comparison
mechanisms and built-in functions. This makes the language more like SQL
in terms of expressiveness, but it works over JSON documents rather than
relations. ObjectPath can be considered a full-featured expression
language. Besides selector mechanism there is also boolean logic, type
system and string concatenation available. On top of that, the language
implementations (Python at the moment; Javascript is in beta!) are
secure and relatively fast.

More at `ObjectPath site <http://objectpath.org/>`__

.. figure:: http://adriank.github.io/ObjectPath/img/op-colors.png
:alt: ObjectPath img

ObjectPath img

ObjectPath makes it easy to find data in big nested JSON documents. It
borrows the best parts from E4X, JSONPath, XPath and SQL. ObjectPath is
to JSON documents what XPath is to XML. Other examples to ilustrate this
kind of relationship are:

============== ==================
Scope Language
============== ==================
text documents regular expression
XML XPath
HTML CSS selectors
JSON documents ObjectPath
============== ==================

Documentation
-------------

`ObjectPath Reference <http://objectpath.org/reference.html>`__

Command line usage
------------------

.. code:: sh

$ sudo pip install objectpath
$ objectpath file.json

or

.. code:: sh

$ git clone https://github.com/adriank/ObjectPath.git
$ cd ObjectPath
$ python shell.py file.json

Python usage
------------

.. code:: sh

$ sudo pip install objectpath
$ python
>>> from objectpath import *
>>> tree=Tree({"a":1})
>>> tree.execute("$.a")
1
>>>

.. code:: sh

$ git clone https://github.com/adriank/ObjectPath.git
$ cd ObjectPath
$ python
>>> from objectpath import *
>>> tree=Tree({"a":1})
>>> tree.execute("$.a")
1
>>>

Contributing & bugs
-------------------

I appreciate all contributions and bugfix requests for ObjectPath,
however since I don’t code in Python any more, this library is not
maintained as of now. Since I can’t fully assure that code contributed
by others meets quality standards, I can’t accept PRs.

If you feel you could maintain this code, ping me. I’d be more than
happy to transfer this repo to a dedicated ObjectPath organization on
GitHub and give the ownership to someone with more time for this project
than me.

License
-------

**MIT**

.. |Downloads| image:: https://img.shields.io/pypi/dm/objectpath.svg
:target: https://pypi.python.org/pypi/objectpath/
.. |Build Status| image:: https://travis-ci.org/adriank/ObjectPath.svg?branch=master
:target: https://travis-ci.org/adriank/ObjectPath
.. |Code Health| image:: https://landscape.io/github/adriank/ObjectPath/master/landscape.png
:target: https://landscape.io/github/adriank/ObjectPath/master
.. |Coverage Status| image:: https://coveralls.io/repos/adriank/ObjectPath/badge.png?branch=master
:target: https://coveralls.io/r/adriank/ObjectPath?branch=master
2 changes: 1 addition & 1 deletion VER
@@ -1 +1 @@
0.5
0.6

0 comments on commit 8e6bec6

Please sign in to comment.