Installation Guide

System Requirements

Python 3.10 or higher
pip package manager
Internet connection (for accessing data sources)

Installing from PyPI (Recommended)

The easiest way to install OneCite is from the Python Package Index (PyPI):

pip install onecite

This will install OneCite and all required dependencies.

Installing from Source

If you want to install a development version from source:

git clone https://github.com/HzaCode/OneCite.git
cd OneCite
pip install -e ".[dev]"

The -e flag installs the package in editable mode, which is useful for development.

Optional Dependencies

For Google Scholar support (disabled by default):

pip install onecite[scholar]

For development and testing:

pip install onecite[dev]

Dev extras:

pytest - Testing framework
pytest-cov - Coverage reporting
flake8 - Code style checking
black - Code formatting tool

Verifying the Installation

To verify that your installation was successful, run:

onecite --version

You should see the version number printed.

Upgrading OneCite

To upgrade to the latest version:

pip install --upgrade onecite

Troubleshooting

Dependency Conflicts

If you encounter dependency conflicts during installation, try:

pip install --upgrade pip setuptools wheel

Then reinstall OneCite.

Permission Errors

If you get permission errors on macOS or Linux, try using the --user flag:

pip install --user onecite

Or consider using a virtual environment (recommended).

Virtual Environments (Recommended)

Using a virtual environment helps avoid system-wide package conflicts:

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
# On Linux/macOS:
source venv/bin/activate
# On Windows:
venv\Scripts\activate

# Install OneCite
pip install onecite

# Deactivate the virtual environment when done
deactivate

Next Steps

After installation, see Quick Start Guide to get started with OneCite.