{
    "info": {
        "author": "S.P. Mohanty",
        "author_email": "mohanty@aicrowd.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Natural Language :: English",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6"
        ],
        "description": "# AIcrowd API\n[![Build Status](https://travis-ci.com/AIcrowd/aicrowd_api.svg?token=thqphyYGsxAAMBx7geLi&branch=master)](https://travis-ci.com/AIcrowd/aicrowd_api)\n\nPython client for server side API of the [aicrowd.com](https://www.aicrowd.com) webapp.\n\n* Free software: GNU General Public License v3\n* Documentation: https://aicrowd-api.readthedocs.io.\n\n# Installation\n## Deployment\n```bash\npip install git+https://github.com/AIcrowd/aicrowd_api.git\n```\n\n## Development\n```bash\ngit clone https://github.com/AIcrowd/aicrowd_api\ncd aicrowd_api\npip install -r requirements_dev.txt\npip install -e .\n```\n\n# Usage\n## Instantiate API object\n```python\nfrom aicrowd_api import API as AICROWD_API\nauth_token=\"<YOUR AICROWD AUTH TOKEN>\"\napi = AICROWD_API(auth_token)\n```\n\n## Authenticate participant\n* with `API_KEY`\n```python\napi.authenticate_participant(EXAMPLE_API_KEY)\n```\n\n* with `username`\n```python\napi_key = api.authenticate_participant_with_username(\"spMohanty\")\n```\n\n## Get all Submissions\n```python\n\nchallenge_id = \"test_challenge\"\nsubmissions = api.get_all_submissions(challenge_id)\nprint(submissions)\n```\n\n## Create Submission\n```python\nchallenge_id = \"test_challenge\"\nsubmission = api.create_submission(challenge_id)\nprint(submission)\n\n# Output\n# ========================================\n# AIcrowdSubmission\t:\t5261\n# \tchallenge_id\t:\ttest_challenge\n# \tround_id\t:\tFalse\n# \tscore\t:\tFalse\n# \tscore_secondary\t:\tFalse\n# \tgrading_status\t:\tsubmitted\n# \tmessage\t:\n# ========================================\n```\n\n## Get submission\n```python\nchallenge_id = \"test_challenge\"\nsubmission_id = 5262\nsubmission = api.get_submission(challenge_id, submission_id)\n```\n\n## Update submission\nAssuming you have a `submission` object by using `api.create_submission` or `api.get_submission`.\nYou can update the submission by :\n\n```python\n# Update params\nsubmission.grading_status = \"graded\"\nsubmission.score = 0.98\nsubmission.score_secondary = 0.98\nsubmission.update()\nprint(submission)\n# Output#\n# ========================================\n# AIcrowdSubmission\t:\t5262\n# \tchallenge_id\t:\ttest_challenge\n# \tround_id\t:\tFalse\n# \tscore\t:\t0.98\n# \tscore_secondary\t:\t0.98\n# \tgrading_status\t:\tgraded\n# \tmessage\t:\n# ========================================\n```\n\n# Tests\n```bash\n# Setup the environment varriables\ncp environ.sh.example environ.sh\n# Then modify the respective environment variables\nsource environ.sh\npytests tests/\n```\n\n# Author\nS.P.Mohanty <mohanty@aicrowd.com>\nArjun Nemani <nemani@aicrowd.com>",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/AIcrowd/aicrowd_api",
        "keywords": "aicrowd_api aicrowd crowdai_api crowdai",
        "license": "GNU General Public License v3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "aicrowd-api",
        "package_url": "https://pypi.org/project/aicrowd-api/",
        "platform": "",
        "project_url": "https://pypi.org/project/aicrowd-api/",
        "project_urls": {
            "Homepage": "https://github.com/AIcrowd/aicrowd_api"
        },
        "release_url": "https://pypi.org/project/aicrowd-api/0.1.23/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Python api for interacting with AIcrowd Grading infrastructure",
        "version": "0.1.23"
    },
    "last_serial": 5657024,
    "releases": {
        "0.1.22": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6bcb04e7d6300f50233850aa44bdd876",
                    "sha256": "58199fb48664b584b7a05b4109b7f6956999902dc82a6a7c81fb3a2448f4f2af"
                },
                "downloads": -1,
                "filename": "aicrowd_api-0.1.22.tar.gz",
                "has_sig": false,
                "md5_digest": "6bcb04e7d6300f50233850aa44bdd876",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7637,
                "upload_time": "2019-08-08T08:32:07",
                "url": "https://files.pythonhosted.org/packages/89/4b/1a3e0ba1f0d2da421f55764000a41613302c48c9ef5041e063ad74e69499/aicrowd_api-0.1.22.tar.gz"
            }
        ],
        "0.1.23": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4d3afb4a2096ace57db493048f22d2b8",
                    "sha256": "6a861ec4b097506f9ab83438d7cbfa26b38050da68fb8bb7dc64a13ef743c1c5"
                },
                "downloads": -1,
                "filename": "aicrowd_api-0.1.23.tar.gz",
                "has_sig": false,
                "md5_digest": "4d3afb4a2096ace57db493048f22d2b8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7616,
                "upload_time": "2019-08-09T17:58:00",
                "url": "https://files.pythonhosted.org/packages/cc/98/3c300f0ffef9c3910fc72a8e2a2f56e6a849bbdf16965c3bd8c16ddf26ab/aicrowd_api-0.1.23.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4d3afb4a2096ace57db493048f22d2b8",
                "sha256": "6a861ec4b097506f9ab83438d7cbfa26b38050da68fb8bb7dc64a13ef743c1c5"
            },
            "downloads": -1,
            "filename": "aicrowd_api-0.1.23.tar.gz",
            "has_sig": false,
            "md5_digest": "4d3afb4a2096ace57db493048f22d2b8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7616,
            "upload_time": "2019-08-09T17:58:00",
            "url": "https://files.pythonhosted.org/packages/cc/98/3c300f0ffef9c3910fc72a8e2a2f56e6a849bbdf16965c3bd8c16ddf26ab/aicrowd_api-0.1.23.tar.gz"
        }
    ]
}