[FEATURE] Adding Typer to custom package using entry points

Wuhuu finally started using Typer and very excited about it.

I went ahead and used the most simple example

import typer

def main(name: str):
    typer.echo(f"Hello {name}")


if __name__ == "__main__":
    typer.run(main)

which works just fine obviously. But I’d like to expose my custom package with CLI using Typer so I made a setup.py with

from setuptools import setup

setup(
    name="my_package",
    entry_points={
        "console_scripts": ["hello = my_package.cli:main"],
    },
)

Then I can call the command using hello in a terminal BUT it doesn’t carry over any positional arguments. Maybe you could add some about entry points integration in the docs?

[tiangolo]

Thanks for the discussion here everyone!

If you have simple scripts and you want to get completion, you can now use Typer CLI to run your Typer scripts without having to install anything.

If you want to create a package, there’s a new guide Building a Package 🎉 .

[maartenq]

The entry_point should point so something executing typer.run. Something like this would do:

import typer

def main(name: str):
    typer.echo(f"Hello {name}")

def run():
    typer.run(main)

if __name__ == "__main__":
    run()

from setuptools import setup

setup(
    name="my_package",
    entry_points={
        "console_scripts": ["hello = my_package.cli:run"],
    },
)