Commit 2b8281a6 authored by Niall McDaid's avatar Niall McDaid
Browse files

automatic updates to setup dependencies

parent eb6380b7
......@@ -145,7 +145,11 @@ The `setup.py` file at the root of this repository defines how the module is pac
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>"`.
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. This can be done manually or automatically.
- To add dependencies manually, add a new element of the form `"package_name==<version>"` within the `install_requires` list in the `setup()` function.
- To add dependencies automatically, first ensure the `setup.py` file is in the same location as the `Pipfile.lock` file. Navigate to this directory and run the command `pipenv-setup sync`. Use this command with care and always double check any changes that have been made to `setup.py` before committing them.
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
......
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