Skip to content

Commit 7f1d110

Browse files
committed
Rename to aclimatise in docs, CLI and README
1 parent 2f2f7bb commit 7f1d110

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ jobs:
100100
run: |
101101
# We need an unpublished version of PyParsing for this
102102
pip install -U git+https://github.com/pyparsing/pyparsing.git#egg=pyparsing[diagrams]
103-
acclimatise railroad > docs/_static/railroad.html
103+
aclimatise railroad > docs/_static/railroad.html
104104
105105
- name: Build the documentation
106106
run: |

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
Acclimatise
1+
aCLImatise
22
***********
33
For the full documentation, refer to the `Github Pages Website
44
<https://aclimatise.github.io/CliHelpParser/>`_.
55

66
======================================================================
77

8-
Acclimatise is a Python library and command-line utility for parsing the help output
8+
aCLImatise is a Python library and command-line utility for parsing the help output
99
of a command-line tool and then outputting a description of the tool in a more
1010
structured format, for example a
1111
`Common Workflow Language tool definition <https://www.commonwl.org/v1.1/CommandLineTool.html>`_.
1212

13-
Currently Acclimatise supports both `CWL <https://www.commonwl.org/>`_ and
13+
Currently aCLImatise supports both `CWL <https://www.commonwl.org/>`_ and
1414
`WDL <https://openwdl.org/>`_ outputs, but other formats will be considered in the future, especially pull
1515
requests to support them.
1616

@@ -47,7 +47,7 @@ utility. Running ``wc --help`` returns:
4747
Full documentation at: <http://www.gnu.org/software/coreutils/wc>
4848
or available locally via: info '(coreutils) wc invocation'
4949
50-
If you run ``acclimatise explore wc``, which means "parse the wc command and all subcommands",
50+
If you run ``aclimatise explore wc``, which means "parse the wc command and all subcommands",
5151
you'll end up with the following files in your current directory:
5252

5353
* ``wc.cwl``

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Python API
22
==========
3-
.. automodule:: acclimatise
3+
.. automodule:: aclimatise
44
:members: parse_help, best_cmd, explore_command, execute_cmd
55
:undoc-members:
66
:show-inheritance:

docs/cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Command Line Interface
22
======================
33

4-
.. click:: acclimatise.cli:main
5-
:prog: acclimatise
4+
.. click:: aclimatise.cli:main
5+
:prog: aclimatise
66
:show-nested:
77
:commands: explore, pipe
88

docs/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ To install ``aCLImatise``, run:
55

66
.. code-block:: bash
77
8-
pip install acclimatise
8+
pip install aclimatise
99
python -m spacy download en # Install an internal language model
1010
1111
Now you can use either the :doc:`Python API <api>` or the :doc:`CLI <cli>`.

docs/model.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,38 @@ Data Model
33

44
Command
55
-------
6-
.. autoclass:: acclimatise.model.Command
6+
.. autoclass:: aclimatise.model.Command
77
:members:
88

99
Command Inputs
1010
--------------
11-
.. autoclass:: acclimatise.model.CliArgument
11+
.. autoclass:: aclimatise.model.CliArgument
1212
:members:
13-
.. autoclass:: acclimatise.model.Positional
13+
.. autoclass:: aclimatise.model.Positional
1414
:members:
15-
.. autoclass:: acclimatise.model.Flag
15+
.. autoclass:: aclimatise.model.Flag
1616
:members:
17-
.. autoclass:: acclimatise.model.FlagSynonym
17+
.. autoclass:: aclimatise.model.FlagSynonym
1818
:members:
1919

2020
Flag Arguments
2121
--------------
22-
.. autoclass:: acclimatise.model.FlagArg
22+
.. autoclass:: aclimatise.model.FlagArg
2323
:members:
24-
.. autoclass:: acclimatise.model.EmptyFlagArg
24+
.. autoclass:: aclimatise.model.EmptyFlagArg
2525
:members:
26-
.. autoclass:: acclimatise.model.OptionalFlagArg
26+
.. autoclass:: aclimatise.model.OptionalFlagArg
2727
:members:
28-
.. autoclass:: acclimatise.model.SimpleFlagArg
28+
.. autoclass:: aclimatise.model.SimpleFlagArg
2929
:members:
30-
.. autoclass:: acclimatise.model.RepeatFlagArg
30+
.. autoclass:: aclimatise.model.RepeatFlagArg
3131
:members:
32-
.. autoclass:: acclimatise.model.ChoiceFlagArg
32+
.. autoclass:: aclimatise.model.ChoiceFlagArg
3333
:members:
3434

3535
Argument Types
3636
--------------
37-
.. automodule:: acclimatise.cli_types
37+
.. automodule:: aclimatise.cli_types
3838
:members:
3939
:undoc-members:
4040
:show-inheritance:

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[metadata]
22
name = aclimatise
3-
version = 2.0.0
3+
version = 2.0.0.post1
44
description = aCLImatise is a Python library and command-line utility for parsing the help output of a command-line tool and then outputting a description of the tool in a more structured format
55
long_description = file: README.rst
66
long_description_content_type: text/x-rst

0 commit comments

Comments
 (0)