The project was developed through a virtual environment with virtualenvwrapper and we highly recommend to do so as well. However, whether or not you are in a virtual environment, the installation proceeds as follows:

• To download and install a standalone executable:
  The standalone executable can be found in the dist/ folder and be used using the --help flag

• To download and install the source code of the project:

    $ cd <directory you want to install to>
    $ git clone https://github.com/QDucasse/IssuuTracker
    $ python setup.py install

• To download and install the source code of the project in a new virtual environment:

  Download of the source code & Creation of the virtual environment

    $ cd <directory you want to install to>
    $ git clone https://github.com/QDucasse/IssuuTracker
    $ cd dm_cw1
    $ mkvirtualenv -a . -r requirements.txt VIRTUALENV_NAME

  Launch of the environment & installation of the project

    $ workon VIRTUALENV_NAME
    $ pip install -e .

  ---

  Objectives and Milestones of the project

  • Views by country/continent (Q.2a,Q.2b)
  • Views by browser (Q.3)
  • "Also likes" functionality (Q.4)
  • "Also likes" graph (Q.5)
  • GUI usage (Q.6)
  • Command line wrapper (Q.7)

  ---

In order to contribute, first ensure you have the latest version by:

Steps to do once in the beginning:

• Forking the project under your Github profile
• Cloning the project on your computer as explained above
• Setting a remote

  $ git remote add upstream https://github.com/QDucasse/IssuuTracker

Steps to do before beginning your work on the project:

• Updating your local repository with the latest changes

  $ git fetch upstream
  $ git checkout master
  $ git merge upstream/master

Steps to do to push your changes:

• Push the changes to your local directory

  $ git add <files-that-changed>
  $ git commit -m "Commit message"
  $ git push

• Open a pull request on github.com/QDucasse/IssuuTracker