Skip to content

Commit c8b179c

Browse files
committed
Rename dad to python-inspector #35
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
1 parent 22f7d5b commit c8b179c

File tree

10 files changed

+15
-17
lines changed

10 files changed

+15
-17
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Usage
3131

3232
pip install git+https://github.com/nexB/python-inspector
3333

34-
- Run a command line with::
34+
- Run the command line utility with::
3535

36-
dad --help
36+
python-inspector --help
3737

3838

3939

docs/source/dependencies-design.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
This is a design to create a new command line tool to resolve Python
77
dependencies for a given Python version, operating system and
8-
architecture. Thename for this new tool is “python-inspector”.
8+
architecture. The name for this new tool is “python-inspector”.
99

1010

1111
***************
@@ -171,8 +171,7 @@ User experience:
171171
The goal of the command line interface and user experience is to be
172172
obvious and familiar to a pip user.
173173

174-
Create a new CLI named "dad" short for "dad analyzes dependencies" with
175-
these key options:
174+
We will create a new CLI named "python-inspector" with these key options:
176175

177176
Inputs:
178177
~~~~~~~~~

docs/source/test-protocol.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ packages that were installed during the build.
7373
Step 4: Resolve dependencies using development requirement files
7474
--------------------------------------------------------------------
7575

76-
In this step, you will resolve the dependencies using python-inspector dad
76+
In this step, you will resolve the dependencies using python-inspector python-inspector
7777
command for each of the requirements files identified in Step 1 using the
7878
Python version identified in Step 2. Run this command for each requirements
7979
file, using each time a different output file name. We assume here Python
8080
version 3.8 (note the absence of dot when passed as a command line option::
8181

82-
dad --python-version 38 --requirement <path/to/requirements.txt> \
82+
python-inspector --python-version 38 --requirement <path/to/requirements.txt> \
8383
--json <path/to/resolved-requirements.txt.json> \
8484
--netrc <path/to/.netrc>
8585

@@ -238,10 +238,10 @@ Step 4: Resolve dependencies using development requirement files
238238
cd ~/tmp/pyinsp-example/tools/python-inspector
239239
source venv/bin/activate
240240

241-
dad --requirement ~/tmp/pyinsp-example/ion/docs/rtd-requirements.txt \
241+
python-inspector --requirement ~/tmp/pyinsp-example/ion/docs/rtd-requirements.txt \
242242
--json ~/tmp/pyinsp-example/output/resolved-rtd-requirements.txt.json
243243

244-
dad --requirement ~/tmp/pyinsp-example/ion/requirements.txt \
244+
python-inspector --requirement ~/tmp/pyinsp-example/ion/requirements.txt \
245245
--json ~/tmp/pyinsp-example/output/resolved-requirements.txt.json
246246

247247
deactivate

setup.cfg

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ where = src
7474

7575
[options.entry_points]
7676
console_scripts =
77-
dad = python_inspector.resolve_cli:resolve_dependencies
7877
python-inspector = python_inspector.resolve_cli:resolve_dependencies
7978

8079
[options.extras_require]

src/python_inspector/resolve_cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ def resolve_dependencies(
170170
For example, display the results of resolving the dependencies for flask==2.1.2
171171
on screen::
172172
173-
dad --spec "flask==2.1.2" --json -
173+
python-inspector --spec "flask==2.1.2" --json -
174174
"""
175175
if not (json_output or pdt_output):
176176
click.secho("No output file specified. Use --json or --json-pdt.", err=True)
@@ -272,7 +272,7 @@ def resolve_dependencies(
272272
)
273273

274274
headers = dict(
275-
tool_name="dad",
275+
tool_name="python-inspector",
276276
tool_homepageurl="https://github.com/nexB/python-inspector",
277277
tool_version=__version__,
278278
options=cli_options,

tests/data/default-url-expected.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"headers": {
3-
"tool_name": "dad",
3+
"tool_name": "python-inspector",
44
"tool_homepageurl": "https://github.com/nexB/python-inspector",
55
"tool_version": "0.5.0",
66
"options": [

tests/data/pinned-requirements.txt-expected.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"headers": {
3-
"tool_name": "dad",
3+
"tool_name": "python-inspector",
44
"tool_homepageurl": "https://github.com/nexB/python-inspector",
55
"tool_version": "0.5.0",
66
"options": [

tests/data/single-url-except-simple-expected.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"headers": {
3-
"tool_name": "dad",
3+
"tool_name": "python-inspector",
44
"tool_homepageurl": "https://github.com/nexB/python-inspector",
55
"tool_version": "0.5.0",
66
"options": [

tests/data/single-url-expected.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"headers": {
3-
"tool_name": "dad",
3+
"tool_name": "python-inspector",
44
"tool_homepageurl": "https://github.com/nexB/python-inspector",
55
"tool_version": "0.5.0",
66
"options": [

tests/data/tilde_req-expected.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"headers": {
3-
"tool_name": "dad",
3+
"tool_name": "python-inspector",
44
"tool_homepageurl": "https://github.com/nexB/python-inspector",
55
"tool_version": "0.5.0",
66
"options": [

0 commit comments

Comments
 (0)