Site Mapper

An API that uses machine learning classification to show which websites are sematically most similar to the website provided

🚧 Work in Progress 🚧

Usage instructions

See the guide

Local setup

1. Setup a mongodb instance either using your local Docker or Mongodb Atlas. Changes to the username and password will require changes to the .env.example file

docker run -e MONGO_INITDB_ROOT_USERNAME=mapper -e MONGO_INITDB_ROOT_PASSWORD=mapper-password -p 27017:27017 mongo

2. Initialise the server on your local machine inside a virtual environment

python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt
cp .env.example .env
python3 wsgi.py
deactivate

Testing

In addition to the local dev setup, unit tests can be run with

pip3 install -r dev-requirements.txt
pytest

Acknowledgement and License

Many thanks to the data scientists who have contributed to Bert, this site is simply an application of your work 💚

License has been inherited from Bert