Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbukhari committed Sep 24, 2024
1 parent 609b523 commit d4f0709
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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+<repository URL>`
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+<repository URL>`

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.

0 comments on commit d4f0709

Please sign in to comment.