Skip to content

Commit 58fd2ab

Browse files
Update docs
2 parents f66f44c + 5301a55 commit 58fd2ab

File tree

5 files changed

+43
-9
lines changed

5 files changed

+43
-9
lines changed

README.rst

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -310,9 +310,28 @@ For example, the ``3 seconds`` item is ready before the preceding ``4 seconds``
310310
Configuration
311311
~~~~~~~~~~~~~
312312
313-
Add code to automatically execute, into your config file.
313+
The config file location follows the `freedesktop.org standard <https://www.freedesktop.org/wiki/Software/xdg-user-dirs/>`_. Check the location on your system by running ``mario --help``:
314+
315+
316+
.. code-block:: bash
317+
318+
% mario --help
319+
Usage: mario [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
320+
321+
Mario: Python pipelines for your shell.
322+
323+
GitHub: https://github.com/python-mario/mario
324+
325+
Configuration:
326+
Declarative config: /home/user/.config/mario/config.toml
327+
Python modules: /home/user/.config/mario/modules/*.py
328+
329+
330+
331+
332+
For example on Ubuntu we use ``~/.config/mario/config.toml`` for declarative configuration. Add code and settings into your config.
333+
314334
315-
For example:
316335
317336
.. code-block:: toml
318337
@@ -495,8 +514,17 @@ Generate json objects
495514
Read csv file
496515
+++++++++++++
497516
498-
Read a csv file into Python dicts.
517+
Read a csv file into Python dicts. Given a csv like this:
518+
519+
520+
.. code-block:: bash
521+
522+
% cat names.csv
523+
name,age
524+
Alice,21
525+
Bob,25
499526
527+
try:
500528
501529
.. code-block:: bash
502530

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 0.0.110
2+
current_version = 0.0.111
33
commit = True
44
tag = True
55

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
setuptools.setup(
1515
name="mario",
16-
version="0.0.110",
16+
version="0.0.111",
1717
description="Shell pipes for Python.",
1818
long_description=open(PROJECT_ROOT / "README.rst").read(),
1919
long_description_content_type="text/x-rst",

src/mario/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.0.110"
1+
__version__ = "0.0.111"

src/mario/cli.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,17 @@
2121

2222
CONTEXT_SETTINGS = {"default_map": config.DEFAULTS}
2323

24-
doc = """Mario: Python pipelines for your shell.
24+
doc = f"""\
25+
Mario: Python pipelines for your shell.
2526
26-
GitHub: https://github.com/python-mario/mario
27+
GitHub: https://github.com/python-mario/mario
2728
28-
"""
29+
\b
30+
Configuration:
31+
Declarative config: {config.get_config_dir() / 'config.toml'}
32+
Python modules: {config.get_config_dir() / 'modules/*.py'}
33+
34+
"""
2935
basics = click.Group(commands=plug.global_registry.cli_functions)
3036
ALIASES = plug.global_registry.aliases
3137

0 commit comments

Comments
 (0)