pypa / pypa/packaging.python.org

Add a tutorial/guide for creating a command line tool

Open
#615 8 comments 0 reactions 1 assignee View on GitHub

@chrysle is already working on this.

Since Apr 27, 2024.

component: guides component: tutorials type: enhancement
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

Related to #614.

As a companion to the packaging tutorial and installing command line tools guide, it'd be nice to have a walkthrough of transforming a command-line utility from running python my_utility.py in the script's directory to running my_utility in an arbitrary location (maybe via pipx?).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.