Development

We are an open source project ran by volunteers. As such, we're always interested in any help or ideas provided by the community.

If you've found a bug, or have some form of idea for a future part of Nidaba, please let us know by raising an Issue. This will allow discussion to foster between the developers and the community.

Contributing to Nidaba

If you wish to contribute code to Nidaba then the best way to do so is to fork the repo and then send us a pull request (PR) so that we can review your work before inclusion into the master copy.

When issuing a PR:

• Nidiba is designed to be used for Python 3.x, please ensure that you're using the most up to date version of Python (3.4 at the time of writing).
• Please follow PEP8. If you don't submit code that follows PEP8, then it is likely your PR will be closed and you'll be asked to submit it again once re-formatted.
• One exception to PEP8 is the issue of an 80 character line length. We accept that 80 characters is quite short, and so don't worry too much about this one. Just make sure the line isn't 1000 characters long. Use your common sense.
• All new code requires documentation, including at the very least docstrings at the top of the function.
• Please test your modifications using out testing framework to ensure that you haven't broken existing code.
• If you've written some code that requires tests, please include them in the PR. If you don't include tests then there is no way to know that what you've written is correct, or if someone in the future makes a modification of it, whether they have broken your code. If you don't include appropriate tests, we can't accept your PR.

Installation

Nidaba is written primarily using Python 3.4. The following steps can be used to install it for development (assuming *nix or OS X):

git clone [email protected]:sopython/nidaba.git
cd nidaba
pyvenv venv
. venv/bin/activate
python setup.py install

Once you've got your virtual environment up to speed (downloading the required python packages), you'll need to install extra bits to be able to unit test and develop with tokenisers and stemmers we use. Run the following from the interactive prompt from within your virtual environment:

import nltk
nltk.download() #This will launch a list UI
d
all
q

System Requirements

Ubuntu (14.04 Trusty Tahr)

Before using the requirements.txt and pip to install the required python packages on a fresh Trusty install - you will require the following: sudo apt-get install libfreetype6-dev python-dev libncurses5-dev libblas-dev liblapack-dev