kavisek / demo-python-cli

A data engineering cli for creating backup on gcp.

Python CLI

This is simple example of how to setup and build a python CLI tool called runner. This repo wil review how to create a simple CLI tool to download an html page and save it to a file.

Setup Instructions

# Activate poetry environment.
cd scraper
poetry install
poetry shell

You can run the CLI tool using the following command. This will invoke the scraper function inside the main.py file.

Any logic within this function will be executed. You can modify this function to your liking.

# CLI Command
scraper https://www.macrumors.com/

The CLI tool with then download the html page and save it to a file called website.txt.

But the problem with this method is that your need poetry installed on the system to run the cli tool. So we need to build the tool into a binary file.

Build Instructions

cd ./scraper
make build --debug

This will output a binary file in the ./scraper/dist folder. You can run this binary file on any system without the need of poetry.

You can vefify that the binary is installed with the following command.

pip list

You should see scraper 0.1.0 in the list of installed packages.

You can remove the binary with pip as well.

pip uninstall scraper

References

• https://dev.to/bowmanjd/build-command-line-tools-with-python-poetry-4mnc
• https://pybit.es/articles/how-to-package-and-deploy-cli-apps/