From d4f07097de62868780730df905653c61af9314b2 Mon Sep 17 00:00:00 2001 From: jbukhari Date: Tue, 24 Sep 2024 17:36:01 -0400 Subject: [PATCH] update README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3a66240..821bc54 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # python-package-template -Template repository for DHL Python packages. +Template for creating Python packages. -This template provides a skeleton directory structure for creating a [Python package](https://docs.python.org/3/tutorial/modules.html#packages). Python packages are collections of [Python modules](https://docs.python.org/3/tutorial/modules.html). For many projects, a single Python module is sufficient. Packages are for projects that may need to combine multiple modules. +This template provides a skeleton directory structure for creating a [Python package](https://docs.python.org/3/tutorial/modules.html#packages). Python packages are collections of one or more [Python modules](https://docs.python.org/3/tutorial/modules.html). The package is configured in the file `setup.py`. -These packages can be installed into a Python virutal environment directly from the Github source code, i.e. `pip install git+` +Packages are meant to be installed into a Python environent uisng [`pip`](https://pypi.org/project/pip/). These packages can be installed directly from the GitHub source code, i.e. `pip install git+` + +Once the package is installed, the modules in the package can be imported into another Python file using [`import`](https://docs.python.org/3/reference/import.html). Modules can also be command-line applications or scripts. \ No newline at end of file