Skip to content

Commit

Permalink
Tidy readme after conversion to RST
Browse files Browse the repository at this point in the history
  • Loading branch information
James McKinney committed Jan 26, 2018
1 parent 36d9f18 commit 159f692
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions README.rst
Expand Up @@ -16,27 +16,25 @@ To install from source:

pip install --upgrade .

``ocdskit`` accepts JSON data from standard input. To report on a remote
file:
To see all commands available, run:

::

curl <url> | ocdskit <command>
ocdskit --help

To report on a local file:
Most ``ocdskit`` tools accept JSON data from standard input. To report on a remote file:

::

cat <path> | ocdskit <command>
curl <url> | ocdskit <command>

To see all commands available, run:
To report on a local file:

::

ocdskit --help
cat <path> | ocdskit <command>

For exploring JSON data, consider using
`jq <https://stedolan.github.io/jq/>`__.
For exploring JSON data, consider using `jq <https://stedolan.github.io/jq/>`__.

Example 1
---------
Expand Down Expand Up @@ -106,8 +104,7 @@ package:

head -n 10000 stream.json | ocdskit combine-record-packages > record_package-1.json

Then, combine the next 10,000 items from the stream into a single record
package:
Then, combine the next 10,000 items from the stream into a single record package:

::

Expand All @@ -126,8 +123,7 @@ Tabulate

cat release_package.json | ocdskit tabulate sqlite:///data.db

For the format of ``database_url``, see the `SQLAlchemy
documentation <https://docs.sqlalchemy.org/en/rel_1_1/core/engines.html#database-urls>`__.
For the format of ``database_url``, see the `SQLAlchemy documentation <https://docs.sqlalchemy.org/en/rel_1_1/core/engines.html#database-urls>`__.

check_documents_urls
--------
Expand All @@ -136,9 +132,7 @@ check_documents_urls

cat release_package.json | ocdskit check_documents_urls --timeout=10


Copyright (c) 2017 Open Contracting Partnership, released under the BSD
license
Copyright (c) 2017 Open Contracting Partnership, released under the BSD license

.. |PyPI version| image:: https://badge.fury.io/py/ocdskit.svg
:target: https://badge.fury.io/py/ocdskit
Expand Down

0 comments on commit 159f692

Please sign in to comment.