search

MDU-PHL / ngmaster

In silico multi-antigen sequence typing for Neisseria gonorrhoeae (NG-MAST)
GNU General Public License v3.0
5 stars 5 forks source link

Pip install #14

Closed andersgs closed 8 years ago

andersgs commented 8 years ago

Made this pip_installable.

Had to move some code around, and re-structure the directory a bit.

You should be able to git clone the branch, if you like, and within a virtualenv, run the following to watch it install.

Testing it out

git clone the repo, and checkout the pip_install branch

Within the repo folder type the following:

virtualenv venv

Once it finishes installing, run the following:

source venv/bin/activate

Then the following:

pip install -U pip # this will update the pip installer to version 8.1.1
python setup.py develop
ngmaster --test

Once ready to send it to PyPi, run the following:

 python setup.py sdist bdist_wheel upload

Go here and here for some explanation about the above command.

Go here for setting up the package distribution.

Go here for an explanation about how to access package resources (i.e., db/ folder)

Go here for a great example of how to put it all together.

For some reason, test.sh was dropped in this branch. So, preserve that file for now. But, we should look transform them into unittest, and put it in the appropriate test folder.