django-ems

django-ems is a multi-user application for tracking people's time on software projects. django-ems is based on django-ems. Documentation of django-ems is available on Read The Docs.

master:
develop:

NEW Features (django-ems)

• Project contracts now have related Technical Assessments
• Keep time track on epics, stories, and tasks assigned
• Development teams with different members seniority per Project

Features already included (django-ems)

• A simple CRM with projects and businesses
• User dashboards with budgeted hours based on project contracts
• Time sheets with daily, weekly, and monthly summaries
• Verified, approved, and invoiced time sheet workflows
• Monthly payroll reporting with overtime, paid leave, and vacation summaries
• Project invoicing with hourly summaries

For*NOTE*: backward compatibility package still named django-ems until we reales the published version

Requirements

django-ems is compatible with Django 1.8 (on Python 2.7 and Python 3.5) and Django 1.9 (on Python 2.7 and Python 3.5). PostgreSQL is the only officially supported backend. For a full list of required libraries, see the requirements/base.txt from the project source on GitHub.

We actively support desktop versions of Chrome and Firefox, as well as common mobile platforms. We do not support most versions of Internet Explorer. We welcome pull requests to fix bugs on unsupported browsers.

Documentation

Documentation is hosted on Read The Docs.

To build the documentation locally:

1. Download a copy of the django-ems source, either through use of git clone or by downloading a zipfile from GitHub.

2. Make sure that the top-level directory is on your Python path. If you're using a virtual environment, this can be accomplished via:

   cd /path/to/django-ems/ && add2virtualenv .
   

3. Install the requirements in requirements/docs.txt from the project source on GitHub.

4. Run make html from within the docs/ directory. HTML files will be output in the docs/_build/html/ directory.

Installation

1. django-ems will be available on PyPI, soon so the easiest way to install right now is adding manually the following line to requirements.txt:

   git+ssh://git@github.com/fetux/django-ems.git@v1.1.01

2. Ensure that less is installed on your machine and the version is <=1.4.0:

   # Install node.js and npm:
   $ sudo apt-get install python-software-properties
   $ sudo add-apt-repository ppa:chris-lea/node.js
   $ sudo apt-get update
   $ sudo apt-get install nodejs npm
   
   # Use npm to install less from package.json:
   $ npm install
   

3. If you are starting from the included example project, copy the example local settings file at example_project/settings/local.py.example to example_project/settings/local.py.

   If you are using an existing project, you will need to make the following changes to your settings:

   • Add ems and its dependencies to INSTALLED_APPS:

     INSTALLED_APPS = (
         ...
         'bootstrap_toolkit',
         'compressor',
         'selectable',
     
         # Must come last.
         'ems',
         'ems.contracts',
         'ems.crm',
         'ems.entries',
         'ems.reports',
     )
     

   • Configure your middleware:

     MIDDLEWARE_CLASSES = (
         'django.middleware.common.CommonMiddleware',
         'django.contrib.sessions.middleware.SessionMiddleware',
         'django.middleware.csrf.CsrfViewMiddleware',
         'django.contrib.auth.middleware.AuthenticationMiddleware',
         'django.contrib.messages.middleware.MessageMiddleware',
     )
     

   • Add django.core.context_processors.request and django-ems context processors to TEMPLATE_CONTEXT_PROCESSORS:

     TEMPLATE_CONTEXT_PROCESSORS = (
         "django.contrib.auth.context_processors.auth",
         "django.core.context_processors.debug",
         "django.core.context_processors.i18n",
         "django.core.context_processors.media",
         "django.contrib.messages.context_processors.messages",
         "django.core.context_processors.request",           # <----
         "ems.context_processors.quick_clock_in",      # <----
         "ems.context_processors.quick_search",        # <----
         "ems.context_processors.extra_settings",      # <----
     )
     

   • Configure compressor settings:

     COMPRESS_PRECOMPILERS = (
         ('text/less', 'lessc {infile} {outfile}'),
     )
     COMPRESS_ROOT = '%s/static/' % PROJECT_PATH
     INTERNAL_IPS = ('127.0.0.1',)
     

   • Set USE_TZ to False. django-ems does not currently support timezones.

4. Run syncdb and migrate.

5. Add URLs for django-ems and selectable to urls.py, e.g.:

   urlpatterns = [
       ...
       (r'^selectable/', include('selectable.urls')),
       (r'', include('ems.urls')),
       ...
   ]
   

6. Add the django.contrib.auth URLs to urls.py, e.g.:

   urlpatterns = [
       ...
       url(r'^accounts/login/$', 'django.contrib.auth.views.login',
           name='auth_login'),
       url(r'^accounts/logout/$', 'django.contrib.auth.views.logout_then_login',
           name='auth_logout'),
       url(r'^accounts/password-change/$',
           'django.contrib.auth.views.password_change',
           name='change_password'),
       url(r'^accounts/password-change/done/$',
           'django.contrib.auth.views.password_change_done'),
       url(r'^accounts/password-reset/$',
           'django.contrib.auth.views.password_reset',
           name='reset_password'),
       url(r'^accounts/password-reset/done/$',
           'django.contrib.auth.views.password_reset_done'),
       url(r'^accounts/reset/(?P<uidb36>[0-9A-Za-z]+)-(?P<token>.+)/$',
           'django.contrib.auth.views.password_reset_confirm'),
       url(r'^accounts/reset/done/$',
           'django.contrib.auth.views.password_reset_complete'),
       ...
   ]
   

7. Create registration templates. For examples, see the registration templates in example_project/templates/registration. Ensure that your project's template directory is added to TEMPLATE_DIRS:

   TEMPLATE_DIRS = (
       ...
       '%s/templates' % PROJECT_PATH,
       ...
   )
   

Development sponsored by Caktus Group.