Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.5 KB

installation-source.md

File metadata and controls

46 lines (30 loc) · 1.5 KB

Installation from source

Installation from source is useful if installation of wheels fail due to some incompatible distribution for your operating system / architecture. Source installations are recommended if you would like to

  • Develop / Contribute to Sugaroid AI
  • A packager for Sugaroid Bot
  • Your OS does not support the wheel
  • You would like to use bleeding edge releases

Installing from Source

Cloning the sugaroid repository

To clone the sugaroid repository, you will need to have git on PATH. You may search this up, and look up possible articles on installing git for your operating system.

git clone https://github.com/srevinsaju/sugaroid.git

If you are low on data, you might like to make a shallow clone (if you would not like to get the previous commits)

git clone https://github.com/srevinsaju/sugaroid.git --depth=1

Installing Sugaroid

You can now install sugaroid using python. Make sure you have setuptools, by default, most python distribution includes setuptools by default

cd sugaroid
python setup.py install

If necessary, you may use the --user flag if you face a PermissionError

Running Sugaroid without installation ( not recommended)

It is also possible to run sugaroid without installing it to your site-packages. This is possible by

cd sugaroid
python -m sugaroid

This will help to run sugaroid directly from source. This is sometimes useful if you are testing sugaroid after making some changes