Installation
Using pip
PyPI install with pip
:
pip install word-vectors
From source
To install from the source, clone the github repository and install with pip.
git clone https://github.com/blester125/word-vectors.git
cd word-vectors
pip install .
Local Development
If you want to install the package and run tests install the optional testing dependencies. You can use the -e
option to install in “editable” mode so that changes you make in the source code will get used without re-installing the package.
pip install .[test]
Run the tests with pytest
.
pytest
Set up pre-commit
hooks to autoformat your changes with black.
pip install pre-commit
pre-commit install
Building the Docs
To build the documentation locally install the documentation requirements and run make.
pip install -r requirements-docs.txt
cd docs
make html
open build/html/index.html