{
    "info": {
        "author": "Zlatko Ma\u0161ek",
        "author_email": "zlatko.masek@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7"
        ],
        "description": "===============================\nShamrock - A Trefle API Library\n===============================\n\n.. image:: https://coveralls.io/repos/github/zmasek/shamrock/badge.svg?branch=master\n   :target: https://coveralls.io/github/zmasek/shamrock?branch=master\n   :alt: Coverage Status\n\n\u2618 **Shamrock** is a Python shallow API library for `Trefle <https://trefle.io/>`_ integration. It\nenables interacting with the Trefle plants API in Python to get the information needed for various\nthings you might want to use the API with such as research, gardening software, automation, etc. It\nis made for use with Python 3.6 and above.\n\nFor the full documentation refer to\n`Shamrock documentation <https://shamrock.readthedocs.io/en/latest/>`_.\n\nFor more information what the Trefle service provides, refer to the\n`Trefle API documentation <https://trefle.io/reference>`_. It is also useful for checking out how to\nuse the API with Shamrock library.\n\nInstallation\n------------\n::\n\n    pipenv install shamrock\n\nor ::\n\n    pip install shamrock\n\nSimple Usage Example\n--------------------\n::\n\n    from shamrock import Shamrock\n    api = Shamrock('mytoken')\n    species = api.species()\n\n\nAdvanced Usage\n--------------\n\nYou can configure the API initially like this::\n\n    api = Shamrock(TOKEN, page_size=10)\n\nCurrently, page_size is the only available option.\n\nMethods that can be run with the API are::\n\n    api.kingdoms()\n    api.subkingdoms()\n    api.divisions()\n    api.families()\n    api.genuses()\n    api.plants()\n    api.species()\n\nThey correspond to the Trefle API endpoints.\n\nYou can also query a specific item from the database::\n\n    api.plants(103505)\n\nSearching is covered with a separate method::\n\n    api.search(\"tomato\")\n\nNavigating the API is covered with these methods::\n\n    api.next()\n    api.prev()\n    api.first()\n    api.last()\n\nIt will work only if you previously made a request. For example::\n\n    api.species()\n    api.next()\n\nBy default, the API responds with the list of whatever number is set in the Trefle. You can\nmanipulate it with previously mentioned page_size::\n\n    api.species(page_size=5)\n\nYou can also use the varoius query string options described on Trefle API documentation as keyword\narguments in methods::\n\n    api.species(common_name=\"blackwood\")\n\n\n=======\nHistory\n=======\n\n0.0.1 (27.04.2019.)\n-------------------\n\n* First release on PyPI.\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/zmasek/shamrock",
        "keywords": "shamrock",
        "license": "MIT license': 'License :: OSI Approved :: MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "shamrock",
        "package_url": "https://pypi.org/project/shamrock/",
        "platform": "",
        "project_url": "https://pypi.org/project/shamrock/",
        "project_urls": {
            "Homepage": "https://github.com/zmasek/shamrock"
        },
        "release_url": "https://pypi.org/project/shamrock/0.0.1/",
        "requires_dist": [
            "requests (==2.21.0)"
        ],
        "requires_python": "",
        "summary": "A Trefle API Integration.",
        "version": "0.0.1"
    },
    "last_serial": 5197048,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7eb07ce2ab3d6d23f9e1ece31e344163",
                    "sha256": "06195a218bde3be15004264545bb9d5edf051224c7892cb7215aaab96a1022db"
                },
                "downloads": -1,
                "filename": "shamrock-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "7eb07ce2ab3d6d23f9e1ece31e344163",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12079,
                "upload_time": "2019-04-27T16:10:18",
                "url": "https://files.pythonhosted.org/packages/93/a4/71a202ee4d9c5dc5146c216d18a0d554704b69988e802a832c732ccc1f05/shamrock-0.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f44d8e7d6f71baef55e7804eec1f6359",
                    "sha256": "077567f68c8e6750043dd8447d66cefe95c091053d2f03f29f43381f58bc1feb"
                },
                "downloads": -1,
                "filename": "shamrock-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "f44d8e7d6f71baef55e7804eec1f6359",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 10307,
                "upload_time": "2019-04-27T16:10:40",
                "url": "https://files.pythonhosted.org/packages/15/53/ff9e252e2623d1219924156d28d609ac95936240c309fc1bbe14876ee880/shamrock-0.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "7eb07ce2ab3d6d23f9e1ece31e344163",
                "sha256": "06195a218bde3be15004264545bb9d5edf051224c7892cb7215aaab96a1022db"
            },
            "downloads": -1,
            "filename": "shamrock-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7eb07ce2ab3d6d23f9e1ece31e344163",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12079,
            "upload_time": "2019-04-27T16:10:18",
            "url": "https://files.pythonhosted.org/packages/93/a4/71a202ee4d9c5dc5146c216d18a0d554704b69988e802a832c732ccc1f05/shamrock-0.0.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f44d8e7d6f71baef55e7804eec1f6359",
                "sha256": "077567f68c8e6750043dd8447d66cefe95c091053d2f03f29f43381f58bc1feb"
            },
            "downloads": -1,
            "filename": "shamrock-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f44d8e7d6f71baef55e7804eec1f6359",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 10307,
            "upload_time": "2019-04-27T16:10:40",
            "url": "https://files.pythonhosted.org/packages/15/53/ff9e252e2623d1219924156d28d609ac95936240c309fc1bbe14876ee880/shamrock-0.0.1.tar.gz"
        }
    ]
}