{
    "info": {
        "author": "Martin Brochhaus",
        "author_email": "mbrochh@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "Django Freckle Budgets\n======================\n\nA reusable Django app that allows to plan year budgets and track them via letsfreckle.\n\nInstallation\n------------\n\nTo get the latest stable release from PyPi\n\n.. code-block:: bash\n\n    pip install django-freckle-budgets\n\nTo get the latest commit from GitHub\n\n.. code-block:: bash\n\n    pip install -e git+git://github.com/bitmazk/django-freckle-budgets.git#egg=freckle_budgets\n\nTODO: Describe further installation steps (edit / remove the examples below):\n\nAdd ``freckle_budgets`` to your ``INSTALLED_APPS``\n\n.. code-block:: python\n\n    INSTALLED_APPS = (\n        ...,\n        'freckle_budgets',\n    )\n\nAdd the ``freckle_budgets`` URLs to your ``urls.py``\n\n.. code-block:: python\n\n    urlpatterns = patterns('',\n        ...\n        url(r'^freckle-budgets/', include('freckle_budgets.urls')),\n    )\n\nDon't forget to migrate your database\n\n.. code-block:: bash\n\n    ./manage.py migrate freckle_budgets\n\nFinally make sure to add the necessary settings to your ``local_settings.py``:\n\n\n.. code-block:: python\n    FRECKLE_BUDGETS_ACCOUNT_NAME = 'your-freckle-account-name' \n    FRECKLE_BUDGETS_API_TOKEN = 'your-freckle-api-token' \n\n\nUsage\n-----\n\nAdd a year\n++++++++++\n\nThe first thing you need to do is to add a year via the Django admin:\n\n* **Year**: This is the year you want to add, i.e. 2015\n* **Rate**: This is your hourly rate that you would like to get for new\n  projects in this year. This value will be used to calculate the potential\n  amount of money you could earn if you were fully booked out (one can be\n  allowed to dream).\n* **Work hours per day**: The number of hours you will definitely work on each\n  work day.\n* **Sick leave days**: The number of sick leave days that you estimate (this is\n  per person, not the total for all employees) \n* **Vacation days**: The number of vacation days that each employee may take\n  during this year.\n\nThese values will be used to calculate the total number of hours that your team\ncan possibly work during any month.\n\nAdd months\n++++++++++\n\nOnce you have added a year, you need to add twelve months for that year via the\nDjango admin:\n\n* **Year**: The year this month belongs to.\n* **Month**: The month number (i.e. 1 for January)\n* **Number of employees**: The number of employees that you will have during\n  this month.\n* **Public holidays**: The number of public holidays that this month has in\n  this year.\n\nAgain, these values are mainly needed to calculate the total number of hours\nthat your team can work during this month.\n\nAdd projects\n++++++++++++\n\nAfter adding a year and it's months, you need to add a few projects via the\nDjango admin:\n\n* **Name**: The display name for this project.\n* **Freckle project ID**: The project ID of this project in your freckle\n  account.\n* **Color**: A CSS color code for this project (i.e. ``#C7B06F``)\n* **Is investment**: If you are working on this project for free (i.e. for\n  internal projects), enable this checkbox.\n\nAdd project budgets to months\n+++++++++++++++++++++++++++++\n\nFor each of your projects, add as many ``ProjectMonth`` objects as needed. For\nexample, if you have a long running project that has budgets for the whole\nyear, you would have to add twelve objects:\n\n* **Project**: The project you want to plan for.\n* **Month**: The month you want to plan for.\n* **Budget**: The budget that you can burn on this project during this month.\n* **Rate**: The hourly rate that you can bill for this project.\n\nAdd employees\n+++++++++++++\n\nBy now, your budget planning should look pretty good. It is time to add some\nemployees. You can do that via the Django admin:\n\n* **Name**: The name of your employee\n* **Freckle ID**: The user id of that employee in Letsfreckle.\n\nAdd employee project months\n+++++++++++++++++++++++++++\n\nFor each ``ProjectMonth`` you can define responsibilities for your employees:\n\n* **ProjectMonth**: Foreign key to the ``ProjectMonth`` you are referring to.\n* **Employee**: Foreign key to the ``Employee`` you are referring to.\n* **Responsibility**: Amount in percent (1-100). For example, 50 would mean\n  that this employee is responsible of working off 50% of the total budget\n  for this project in this month.\n\nAdd free time\n+++++++++++++\n\nIf your employees know that they will have vacation days, or there are public\nholidays, you can track those as well. This will raise the hours per day, since\nthe same amount of hours will have to be spread over lesser days available in\nthe month:\n\n* **Employee**: Foreign key to the ``Employee`` who will be absent.\n* **Day**: The day when the employee will be absent.\n* **Is public holiday**: If ``True``, we will assume that this is a public\n  holiday. This could be interesting in the future to track, public holidays,\n  sick-leave and vacation days.\n* **Is sick leave**: If ``True``, we will assume that this is a sick-leave day.\n  This could be interesting in the future to track, public holidays, sick-leave\n  and vacation days.\n\nContribute\n----------\n\nIf you want to contribute to this project, please perform the following steps\n\n.. code-block:: bash\n\n    # Fork this repository\n    # Clone your fork\n    mkvirtualenv -p python2.7 django-freckle-budgets\n    make develop\n\n    git co -b feature_branch master\n    # Implement your feature and tests\n    git add . && git commit\n    git push -u origin feature_branch\n    # Send us a pull request for your feature branch\n\nIn order to run the tests, simply execute ``tox``. It will create two more\nvenvs and run tests against Django 1.6 and Django 1.7.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/bitmazk/django-freckle-budgets",
        "keywords": "django,app,reusable,budgeting,planning,letsfreckle",
        "license": "The MIT License",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-freckle-budgets",
        "package_url": "https://pypi.org/project/django-freckle-budgets/",
        "platform": "OS Independent",
        "project_url": "https://pypi.org/project/django-freckle-budgets/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/bitmazk/django-freckle-budgets"
        },
        "release_url": "https://pypi.org/project/django-freckle-budgets/0.2/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "A reusable Django app that allows to plan year budgets and track them via letsfreckle.",
        "version": "0.2"
    },
    "last_serial": 1408697,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "288593705d258ea84d75b81b9f3d8d39",
                    "sha256": "06aa47d5b78a361c0165c9cabd7afba7c61e4bac0863d1dd72e0941dd39c1e29"
                },
                "downloads": -1,
                "filename": "django-freckle-budgets-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "288593705d258ea84d75b81b9f3d8d39",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19033,
                "upload_time": "2015-01-20T12:44:29",
                "url": "https://files.pythonhosted.org/packages/a7/10/bd006508163286f09d18ae801bc4e89ecdf7ee68843aae9e037eaf554508/django-freckle-budgets-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8ad2338bcd6eb01da63d39714e5af734",
                    "sha256": "e76fe8b3b70276516b2f1d22bc4af24492cd93046fd8f7e4921b6cf5c42e8815"
                },
                "downloads": -1,
                "filename": "django-freckle-budgets-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "8ad2338bcd6eb01da63d39714e5af734",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 30240,
                "upload_time": "2015-02-04T00:17:10",
                "url": "https://files.pythonhosted.org/packages/37/5e/ce4b4e1676894b5b99a0e97da64a92b57c76bb05db64e3a9f3149e69efb5/django-freckle-budgets-0.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8ad2338bcd6eb01da63d39714e5af734",
                "sha256": "e76fe8b3b70276516b2f1d22bc4af24492cd93046fd8f7e4921b6cf5c42e8815"
            },
            "downloads": -1,
            "filename": "django-freckle-budgets-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "8ad2338bcd6eb01da63d39714e5af734",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 30240,
            "upload_time": "2015-02-04T00:17:10",
            "url": "https://files.pythonhosted.org/packages/37/5e/ce4b4e1676894b5b99a0e97da64a92b57c76bb05db64e3a9f3149e69efb5/django-freckle-budgets-0.2.tar.gz"
        }
    ]
}