indygreg / indygreg/PyOxidizer

Documentation: `pyoxidizer run -- flags` not working without `.`

Open
#125 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
6.2k
Forks
256
PR merge metrics
No merged PRs in 30d

Description

As a learning project, I'm oxidizing [my script that pulls the local fishing report](https://github.com/n8henrie/nmfishingreport). The [examples regarding sending arguments to a script](https://pyoxidizer.readthedocs.io/en/latest/packaging.html#packaging) aren't working for me:

Examples:

```console
# From outside the ``pyflakes`` directory
$ pyoxidizer run /path/to/pyflakes/project -- /path/to/python/file/to/analyze

# From inside the ``pyflakes`` directory
$ pyoxidizer run -- /path/to/python/file/to/analyze
```

I think it may be because I have put all the PyOxidizer stuff in a subdirectory named `oxidize`, so as not to conflict with projects that keep the code in a self-named subdirectory, but I kept the binary named `nmfishingreport` (by changing `application_name` and `name` in `pyoxidizer.toml` and `Cargo.toml` respectively).

My code:

```console
$ pyoxidizer run -- --help
error: entity not found
$ pyoxidizer run nmfishingreport -- --help
error: entity not found
$ pyoxidizer run oxidize -- --help
error: entity not found
```

However, if I just use `.` it properly outputs my help text: `pyoxidizer run . -- --help`.

Perhaps changing the example to include the `.` may help others avoid trouble figuring this out (assuming that others may also want to organize their files as I have, but retain a binary named after the project).

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the packaging documentation at the linked section and compare its `pyoxidizer run` examples with the reported commands. Update the examples to show the working `.` form if appropriate, then verify that the documented commands match the observed CLI behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.