Rename options= to params=

python-mario-bot · web-flow · commit 1d122da19106 · 2019-07-19T21:34:41.000-07:00
Params=
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.3
+current_version = 0.1.5
 commit = True
 tag = True
 
diff --git a/dev-requirements.in b/dev-requirements.in
@@ -17,3 +17,4 @@ pytest-sphinx
 towncrier
 flake8
 pytest-cov
+jinja2
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -24,7 +24,7 @@ flake8==3.7.8
 importlib-metadata==0.18  # via pluggy, pytest, tox
 incremental==17.5.0       # via cuvner, towncrier
 isort==4.3.21
-jinja2==2.10.1            # via towncrier
+jinja2==2.10.1
 lazy-object-proxy==1.4.1  # via astroid
 markupsafe==1.1.1         # via jinja2
 mccabe==0.6.1             # via flake8, pylint
diff --git a/docs/cli_reference.rst b/docs/cli_reference.rst
@@ -0,0 +1,7 @@
+=============
+CLI reference
+=============
+
+.. click:: mario.cli:cli
+   :prog: mario
+   :show-nested:
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,6 +16,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "mario.sphinx_click",
 ]
 if os.getenv("SPELLCHECK"):
     extensions += ("sphinxcontrib.spelling",)
@@ -28,7 +29,7 @@
 year = "2019"
 author = "Mario contributors"
 copyright = "{0}, {1}".format(year, author)
-version = release = "0.1.3"
+version = release = "0.1.5"
 
 pygments_style = "trac"
 templates_path = ["."]
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,7 @@ Contents
    installation
    usage
    reference/index
+   cli_reference
    contributing
    authors
    changelog
diff --git a/docs/reference/mario_addons.plugins.rst b/docs/reference/mario_addons.plugins.rst
@@ -0,0 +1,22 @@
+mario\_addons.plugins package
+=============================
+
+Submodules
+----------
+
+mario\_addons.plugins.addons module
+-----------------------------------
+
+.. automodule:: mario_addons.plugins.addons
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: mario_addons.plugins
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/mario_addons.rst b/docs/reference/mario_addons.rst
@@ -1,9 +1,17 @@
-mario_addons
-============
+mario\_addons package
+=====================
 
-.. testsetup::
+Subpackages
+-----------
 
-    from mario_addons import *
+.. toctree::
+
+   mario_addons.plugins
+
+Module contents
+---------------
 
 .. automodule:: mario_addons
-    :members:
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/reference/modules.rst b/docs/reference/modules.rst
@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   mario_addons
diff --git a/requirements.in b/requirements.in
@@ -1,3 +1,3 @@
-mario>=0.0.123
+mario>=0.0.125
 pyyaml
 lxml
diff --git a/requirements.txt b/requirements.txt
@@ -4,31 +4,56 @@
 #
 #    pip-compile --output-file=requirements.txt requirements.in
 #
+alabaster==0.7.12         # via sphinx
 anyio==1.0.0              # via asks
 appdirs==1.4.3            # via mario
 asks==2.3.5               # via mario
 async-exit-stack==1.0.1   # via mario
 async-generator==1.10     # via anyio, asks, mario, trio
 attrs==19.1.0             # via mario, outcome, trio
+babel==2.7.0              # via sphinx
 bump2version==0.5.10      # via mario
+certifi==2019.6.16        # via requests
+chardet==3.0.4            # via requests
 click==7.0                # via mario
+docutils==0.14            # via mario, sphinx
 h11==0.9.0                # via asks
-idna==2.8                 # via trio
+idna==2.8                 # via requests, trio
+imagesize==1.1.0          # via sphinx
+jinja2==2.10.1            # via sphinx
 lxml==4.3.4
-mario==0.0.122
+mario==0.0.124
+markupsafe==1.1.1         # via jinja2
 marshmallow==3.0.0rc8     # via mario
 mypy-extensions==0.4.1    # via mypy, trio-typing
 mypy==0.720               # via trio-typing
 outcome==1.0.0            # via trio
+packaging==19.0           # via sphinx
 parso==0.5.1              # via mario
+pygments==2.4.2           # via sphinx
+pyparsing==2.4.0          # via packaging
 pyrsistent==0.15.3        # via mario
+pytz==2019.1              # via babel
 pyyaml==5.1.1
-six==1.12.0               # via pyrsistent
+requests==2.22.0          # via sphinx
+six==1.12.0               # via packaging, pyrsistent
 sniffio==1.1.0            # via anyio, trio
+snowballstemmer==1.9.0    # via sphinx
 sortedcontainers==2.1.0   # via trio
+sphinx==2.1.2             # via mario
+sphinxcontrib-applehelp==1.0.1  # via sphinx
+sphinxcontrib-devhelp==1.0.1  # via sphinx
+sphinxcontrib-htmlhelp==1.0.2  # via sphinx
+sphinxcontrib-jsmath==1.0.1  # via sphinx
+sphinxcontrib-qthelp==1.0.2  # via sphinx
+sphinxcontrib-serializinghtml==1.1.3  # via sphinx
 toml==0.10.0              # via mario
 toolz==0.10.0             # via mario
 trio-typing==0.2.0        # via mario
 trio==0.11.0              # via mario, trio-typing
 typed-ast==1.4.0          # via mypy
 typing-extensions==3.7.4  # via mypy, trio-typing
+urllib3==1.25.3           # via requests
+
+# The following packages are considered to be unsafe in a requirements file:
+# setuptools==41.0.1        # via sphinx
diff --git a/setup.py b/setup.py
@@ -33,7 +33,7 @@ def read(*names, **kwargs):
 # Enable code coverage for C code: we can't use CFLAGS=-coverage in tox.ini, since that may mess with compiling
 setup(
     name="mario-addons",
-    version="0.1.3",
+    version="0.1.5",
     description="More commands for Mario.",
     long_description="%s\n%s"
     % (
diff --git a/src/mario_addons/__init__.py b/src/mario_addons/__init__.py
@@ -1 +1 @@
-__version__ = "0.1.3"
+__version__ = "0.1.5"
diff --git a/src/mario_addons/plugins/addons.toml b/src/mario_addons/plugins/addons.toml
@@ -7,7 +7,7 @@ short_help = "Convert yaml to json"
 
 [[command.stage]]
 command = "stack"
-options = {code="yaml.safe_load ! json.dumps"}
+params = {code="yaml.safe_load ! json.dumps"}
 
 [[command.test]]
 invocation = ["yml2json"]
@@ -31,7 +31,7 @@ help = """Pull data out of xml documents using xpath."""
 [[command.stage]]
 
 command = "stack"
-options= {code="x.encode() ! io.BytesIO ! lxml.etree.parse ! x.findall(query) ! map(lambda y: y, x) ! list" }
+params = {code="x.encode() ! io.BytesIO ! lxml.etree.parse ! x.findall(query) ! map(lambda y: y, x) ! list" }
 
 [[command.stage]]
 command="chain"
@@ -63,26 +63,26 @@ inject_values=["pairs"]
 
 [[command.stage]]
 command = "eval"
-options = {code="pairs"}
+params = {code="pairs"}
 
 [[command.stage]]
 command = "map"
-options = {code="shlex.split(x, posix=False)"}
+params = {code="shlex.split(x, posix=False)"}
 
 [[command.stage]]
 command = "chain"
 
 [[command.stage]]
 command = "map"
-options = {code="x.partition('=') ! [x[0], ast.literal_eval(re.sub(r'^(?P<value>[A-Za-z]+)$', r'\"\\g<value>\"', x[2]))]"}
+params = {code="x.partition('=') ! [x[0], ast.literal_eval(re.sub(r'^(?P<value>[A-Za-z]+)$', r'\"\\g<value>\"', x[2]))]"}
 
 [[command.stage]]
 command = "apply"
-options = {"code"="dict"}
+params = {"code"="dict"}
 
 [[command.stage]]
 command = "map"
-options = {code="json.dumps"}
+params = {code="json.dumps"}
 
 
 [[command.test]]
@@ -100,7 +100,7 @@ section ="Read"
 
 command = "map"
 
-options =  {code="json.loads"}
+params =  {code="json.loads"}
 
 [[command.test]]
 invocation = ["read-jsonl"]
@@ -110,6 +110,33 @@ output = """{'name': 'Alice', 'age': '21'}\n{'name': 'Bob', 'age': '22'}\n"""
 
 [[command]]
 name = "read-csv"
+help = """
+
+Read a csv file into Python dicts. Given a csv like this:
+
+
+.. code-block::
+
+    name,age
+    Alice,21
+    Bob,25
+
+try:
+
+.. code-block:: bash
+
+    $ mario read-csv <<EOF
+    name,age
+    Alice,21
+    Bob,25
+    EOF
+    {'name': 'Alice', 'age': '21'}
+    {'name': 'Bob', 'age': '25'}
+
+
+Specify the ``--delimiter=`` or ``--no-header`` options as needed.
+
+"""
 short_help = "Load csv rows into python objects"
 inject_values=["delimiter", "header"]
 section ="Read"
@@ -126,14 +153,14 @@ help = "Treat the first row as a header?"
 
 [[command.stage]]
 command = "apply"
-options = {code="mario_addons.plugins.addons.read_csv(x, header=header)"}
+params = {code="mario_addons.plugins.addons.read_csv(x, header=header)"}
 
 [[command.stage]]
 command = "chain"
 
 [[command.stage]]
 command = "map"
-options = {code="dict(x)"}
+params = {code="dict(x)"}
 
 [[command.test]]
 invocation = ["read-csv"]
@@ -148,7 +175,7 @@ section = "Read"
 
 [[command.stage]]
 command = "stack"
-options = {code="yaml.safe_load"}
+params = {code="yaml.safe_load"}
 
 [[command.test]]
 invocation = ["read-yaml"]
@@ -162,7 +189,7 @@ section = "Write"
 
 [[command.stage]]
 command = "apply"
-options={code="json.dumps"}
+params ={code="json.dumps"}
 
 [[command.test]]
 invocation = ["stack", "str.split", "write-json"]
@@ -177,7 +204,7 @@ section = "Write"
 
 [[command.stage]]
 command = "map"
-options={code="toml.dumps"}
+params ={code="toml.dumps"}
 
 [[command.test]]
 invocation = ["stack", "json.loads", "write-toml"]
diff --git a/tox.ini b/tox.ini
@@ -61,7 +61,7 @@ deps=
     codecov
 commands=
     python -c 'import sys; print(sys.version)'
-    codecov --required
+    codecov
 
 
 [testenv:doc]

-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 -mario>=0.0.123
 +mario>=0.0.125
 pyyaml
 lxml