Installation

Requirements

Installation Methods

The easiest way to install the Literature Review Tool is via pip from PyPI:

pip install literature_search

This will install the latest stable version with all required dependencies.

Install from Wheel File

If you have a pre-built wheel file:

pip install dist/literature_search-*.whl

Install from Source

To install from the source repository:

  1. Clone the repository: 
    git clone https://github.com/shanakaprageeth/literature_search.git
cd literature_search
  2. Install dependencies: 
    pip install -r requirements.txt
  3. Build and install: 
    python -m build
pip install dist/literature_search-*.whl

Verifying Installation

After installation, verify that the tool is correctly installed by running:

literature-search --help

You should see the help message with available options.

Upgrading

To upgrade to the latest version:

pip install --upgrade literature_search

Uninstalling

To remove the Literature Review Tool:

pip uninstall literature-search

Dependencies

The tool automatically installs the following dependencies:

Troubleshooting

Permission Errors

If you encounter permission errors during installation:

pip install --user literature_search

Or use a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install literature_search

Python Version Issues

Ensure you’re using Python 3.9 or higher:

python --version

If you have multiple Python versions, you may need to specify:

python3.9 -m pip install literature_search

Missing Dependencies

If dependencies fail to install automatically, install them manually:

pip install matplotlib>=3.10.3 drawpyo>=0.2.2 requests pytest

Next Steps

After installation, proceed to: