{ "info": { "author": "Sergio Oliveira", "author_email": "sergio@tracy.com.br", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Internet :: WWW/HTTP :: WSGI" ], "description": ".. -*- coding: utf-8 -*-\r\n\r\n.. highlight:: rest\r\n\r\n.. _colab_software:\r\n\r\n=================================\r\nColab, a Software for Communities\r\n=================================\r\n\r\n.. image:: https://travis-ci.org/colab/colab.svg?branch=master\r\n :target: https://travis-ci.org/colab/colab\r\n\r\n.. image:: https://coveralls.io/repos/colab/colab/badge.png?branch=master\r\n :target: https://coveralls.io/r/colab/colab?branch=master\r\n\r\n\r\nWhat is Colab?\r\n==============\r\n\r\nApplication that integrates existing systems to represent the contributions of the members through:\r\n\r\n* The amendments to the Wiki trac system.\r\n\r\n* Changes to the trac system code.\r\n\r\n* Discussions at the mailman list.\r\n\r\n* And other systems in the community.\r\n\r\n\r\n\r\nFeatures\r\n========\r\n\r\n* Developed by Interlegis Communities http://colab.interlegis.leg.br/\r\n\r\n* Written in Python http://python.org/\r\n\r\n* Built with Django Web Framework https://www.djangoproject.com/\r\n\r\n* Search engine with Solr https://lucene.apache.org/solr/\r\n\r\n\r\n\r\nInstallation\r\n============\r\n\r\nFirst install the dependencies and than the project it self:\r\n\r\n.. code-block::\r\n\r\n pip install -e .\r\n\r\nDevelopment environment\r\n-----------------------\r\n\r\nYou must install vagrant to set up the development environment. With vagrant available you should run:\r\n\r\n.. code-block::\r\n\r\n vagrant up\r\n\r\nDuring the process you should choose the vagrant box that you want to use. In the end you should have a virtual machine with development environment set up.\r\n\r\nIf you want to run locally, you must setup your settings file on /etc/colab:\r\n\r\n.. code-block::\r\n ## Set to false in production\r\n DEBUG = True\r\n TEMPLATE_DEBUG = True\r\n\r\n SECRET_KEY = 'secret'\r\n\r\n ALLOWED_HOSTS = [\r\n 'localhost',\r\n ]\r\n\r\n\r\n\r\nRunning Colab\r\n=============\r\n\r\nTo run Colab with development server you will have to:\r\n\r\n1- Log in virtual machine:\r\n\r\n.. code-block::\r\n\r\n vagrant ssh\r\n \r\n2- Use colab virtualenv:\r\n\r\n.. code-block::\r\n\r\n workon colab\r\n \r\n3- Run the development server: \r\n\r\n.. code-block::\r\n\r\n colab-admin runserver 0.0.0.0:8000\r\n\r\nNow you can access colab in your browser via http://localhost:8000\r\n\r\n**NOTE**: In case you want to keep the configuration file else where just set the \r\ndesired location in environment variable **COLAB_SETTINGS**.\r\n\r\nAbout test\r\n==========\r\n\r\nHow to write a test\r\n--------------------\r\nInside of each folder on /vagrant/colab/ you can create a folder called\r\n\"tests\" and inside of it implements the code for test each file. Remember that you should create __init__.py file.\r\n \r\nHow to run the tests\r\n--------------------\r\n\r\nFollow the steps below:\r\n\r\n1- Log in virtual machine:\r\n\r\n.. code-block::\r\n\r\n vagrant ssh\r\n\r\n2- Use colab virtualenv:\r\n\r\n.. code-block::\r\n\r\n workon colab\r\n\r\n3- Enter into colab source code directory:\r\n\r\n.. code-block::\r\n\r\n cd /vagrant\r\n\r\n4- Run tests with setup.py:\r\n\r\n.. code-block::\r\n\r\n python setup.py test", "description_content_type": null, "docs_url": "https://pythonhosted.org/colab/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/colab-community/colab", "keywords": "colab collaboration", "license": "LICENSE.txt", "maintainer": "", "maintainer_email": "", "name": "colab", "package_url": "https://pypi.org/project/colab/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/colab/", "project_urls": { "Homepage": "https://github.com/colab-community/colab" }, "release_url": "https://pypi.org/project/colab/1.13.5/", "requires_dist": null, "requires_python": "", "summary": "Collaboration platform for communities", "version": "1.13.5" }, "last_serial": 2045242, "releases": { "1.13.5": [ { "comment_text": "", "digests": { "md5": "745c395c4c0232c70c330667b0ac410f", "sha256": "1ebcde8db56b84e85384df1cff9b41709c6caf0b120947c930c5bbe038828ce6" }, "downloads": -1, "filename": "colab-1.13.5.tar.gz", "has_sig": false, "md5_digest": "745c395c4c0232c70c330667b0ac410f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 567653, "upload_time": "2016-04-04T17:35:28", "url": "https://files.pythonhosted.org/packages/cf/4c/028c9b0e05e4bc308522d6835aed72ebcd3dc2d8e7cd2287fe790c3be1aa/colab-1.13.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "745c395c4c0232c70c330667b0ac410f", "sha256": "1ebcde8db56b84e85384df1cff9b41709c6caf0b120947c930c5bbe038828ce6" }, "downloads": -1, "filename": "colab-1.13.5.tar.gz", "has_sig": false, "md5_digest": "745c395c4c0232c70c330667b0ac410f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 567653, "upload_time": "2016-04-04T17:35:28", "url": "https://files.pythonhosted.org/packages/cf/4c/028c9b0e05e4bc308522d6835aed72ebcd3dc2d8e7cd2287fe790c3be1aa/colab-1.13.5.tar.gz" } ] }