Commit 042f264a authored by Niall McDaid's avatar Niall McDaid
Browse files

Add info on setup.py

parent 47eb321f
......@@ -124,6 +124,14 @@ The following guidance should be followed where possible:
## Package Deployment and Installation
### setup.py
The `setup.py` file at the root of this repository defines how the module is packaged. It defines the package version (which is generated automatically as defined in the [Manual Step](#manual-step) subsection below) and package dependencies.
The majority of this file should not require editing but the `install_requires` section of the main `setup` function will need updating when new package dependencies are introduced.
#### Adding New Dependencies
When new dependencies are added to the Pipfile, they will also need to be added to the `setup.py` file so that they are installed as part of the package installation. Within the `install_requires` list, add a new element of the form `"package_name==<version>"`.
More information can be found in the Python documentation [here](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#install-requires).
### Install from Repository Source
The *wbdutil* module can be installed in edit mode on the command line by running the following command in the root folder of the repository:
```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment