{ "info": { "author": "Lenselle Nicolas", "author_email": "lenselle.nicolas@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Programming Language :: Python" ], "description": "**`\ud83c\uddeb\ud83c\uddf7\nFran\u00e7ais `__**\n\nPython helper to request Sirene API\n\nAPI Sirene give access to French companies and business database.\nEntities are recorded since the creation of this administrative register\nin 1973. To use this API you have to create an account on\nhttps://api.insee.fr/\n\nThe python library ``api_insee`` is a help to request the API Sirene in\nperfect simplicity. You'll find more information about the API in the\n`official\ndocumentation `__\n\nInstallation\n^^^^^^^^^^^^\n\nFrom a terminal :\n\n``pip install api-insee``\n\nTo request the API you must create a consummer account on\n`api.insee.fr `__. Then with your access keys :\n\n.. code:: python\n\n from api_insee import ApiInsee\n\n api = ApiInsee(\n key = # consummer key,\n secret = # secret key\n )\n\n--------------\n\nRequest samples\n^^^^^^^^^^^^^^^\n\n- Fetch data from a siret or sirene number\n\n.. code:: python\n\n data = api.siren('005520135').get()\n data = api.siret('39860733300059').get()\n\n\n # Request executed:\n # https://api.insee.fr/entreprises/sirene/V3/siren/005520135\n # https://api.insee.fr/entreprises/sirene/V3/siret/39860733300059\n\n- Set parameters to the request:\n\n.. code:: python\n\n data = api.siren('005520135', date='2018-01-01').get()\n\n # Request executed:\n # https://api.insee.fr/entreprises/sirene/V3/siren/005520135?date=2018-01-01\n\n- Perform an advanced search on given criteria using ``q=`` parameter\n\n.. code:: python\n\n data = api.siren(q='unitePurgeeUniteLegage:True').get()\n\n # Request executed:\n # /?q=unitePurgeeUniteLegage:True\n\n- Filter fields in the response\n\n.. code:: python\n\n champs = [\n 'siret',\n 'denominationUniteLegale',\n 'nomUsageUniteLegale',\n 'prenom1UniteLegale',\n ]\n\n request = api.siret('39860733300059', champs=champs)\n # Request executed:\n # /39860733300059?champs=siret,denominationUniteLegale,nomUsageUniteLegale,prenom1UniteLegale\n\n--------------\n\nAdvanced search on criteria\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nClass in ``api_insee.criteria`` let you construct advanced searchs\neasily. All variables available are described in the `official\ndocumentation `__\n\n- You can combine several criteria in one request.\n\n.. code:: python\n\n from api_insee.criteria import Field\n\n data = api.siren(q=(\n Field('codeCommuneEtablissement', 92046),\n Field('unitePurgeeUniteLegale', True)\n )).get()\n\n\n # Request executed:\n # /?q=codeCommuneEtablissement:92046 AND unitePurgeeUniteLegale:True\n\n- Or using a dictionnary\n\n.. code:: python\n\n\n data = api.siren(q={\n 'codeCommuneEtablissement' : 92046,\n 'unitePurgeeUniteLegale' : True\n }).get()\n\n\n # Request executed:\n # /?q=codeCommuneEtablissement:92046 AND unitePurgeeUniteLegale:True\n\n- Use logical operator ``|``, ``&``, ``- (not)`` to specify your\n requests.\n\n.. code:: python\n\n\n data = api.siren(q=(\n Field('codeCommuneEtablissement', 92046) | Field('unitePurgeeUniteLegale', True)\n )).get()\n\n data = api.siren(q=-Field('codeCommuneEtablissement', 92046)).get()\n\n # Request executed:\n # /?q=codeCommuneEtablissement:92046 OR unitePurgeeUniteLegale:True\n # /?q=-codeCommuneEtablissement:92046\n\nSpecial Search\n''''''''''''''\n\n+-------+--------------+----------+\n| Type | Description | Example |\n+=======+==============+==========+\n| Field | Search on an | FieldExa |\n| Exact | exact value | ct('demo |\n| | | nination |\n| | | UniteLeg |\n| | | ale','LE |\n| | | TIMBRE') |\n| | | ) |\n+-------+--------------+----------+\n| Perio | Search on | Periodic |\n| dic | periodic | (Field(' |\n| | field | activite |\n| | | Principa |\n| | | leUniteL |\n| | | egale',' |\n| | | 84.23Z') |\n+-------+--------------+----------+\n| Range | Search in a | Range('n |\n| | range of | omUsageU |\n| | values | niteLega |\n| | | le', |\n| | | 'DUPONT' |\n| | | , |\n| | | 'DURANT' |\n| | | ) |\n+-------+--------------+----------+\n\n--------------\n\nPagination\n^^^^^^^^^^\n\nThe ``pages()`` method return an iterator to let you fetch pages from\nthe api. To specify the number of results per page use the ``nombre``\nargument. Results are limited by 10000 per pages.\n\n.. code:: python\n\n from api_insee import ApiInsee\n\n api = ApiInsee(\n key = # consummer key,\n secret = # secret key\n )\n\n request = api.siren(q={\n 'categorieEntreprise': 'PME'\n })\n\n for (page_index, page_result) in enumerate(request.pages(nombre=1000)):\n # process here\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sne3ks/api_insee", "keywords": "", "license": "mit", "maintainer": "", "maintainer_email": "", "name": "api-insee", "package_url": "https://pypi.org/project/api-insee/", "platform": "any", "project_url": "https://pypi.org/project/api-insee/", "project_urls": { "Homepage": "https://github.com/sne3ks/api_insee" }, "release_url": "https://pypi.org/project/api-insee/1.4/", "requires_dist": [ "pytest ; extra == 'testing'", "pytest-cov ; extra == 'testing'" ], "requires_python": "", "summary": "Python helper to request Sirene Api on api.insee.fr", "version": "1.4" }, "last_serial": 5780267, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "774027582bb2801a4c5683a73ece8d30", "sha256": "297e07a7640363c636a3c4cfbe170356a1b66f728a264dd5e4bd80c204ebc837" }, "downloads": -1, "filename": "api_insee-1.0.1.tar.gz", "has_sig": false, "md5_digest": "774027582bb2801a4c5683a73ece8d30", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9985, "upload_time": "2019-01-04T19:02:38", "url": "https://files.pythonhosted.org/packages/76/c1/bc26c6b0d5fd8ccf6ad5358492ed703225a3b128ec0cd199c316fefdf370/api_insee-1.0.1.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "a21b0188a6356906c4f12084c56a331a", "sha256": "dcdffff8a5b5e73237523a50cfa9bca09c9df6fc46d7bcf97ab67db41d0f63a7" }, "downloads": -1, "filename": "api_insee-1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a21b0188a6356906c4f12084c56a331a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13606, "upload_time": "2019-08-22T10:14:23", "url": "https://files.pythonhosted.org/packages/66/2f/b8dbbfbaf458792bbbe8d373ed2be08c065521edb4425b787fdefc588370/api_insee-1.2-py2.py3-none-any.whl" } ], "1.3": [ { "comment_text": "", "digests": { "md5": "0d88e36634ff68c8e434067e58c1346c", "sha256": "005e078231c4ce7ff30e3716536f0a5e9d682ef946fba1e491c02c80ba922873" }, "downloads": -1, "filename": "api_insee-1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0d88e36634ff68c8e434067e58c1346c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13869, "upload_time": "2019-09-03T09:57:23", "url": "https://files.pythonhosted.org/packages/f2/9a/92da6ba6cb08fffcd9170794695684efe8bf522f77df53a231e6beae6de7/api_insee-1.3-py2.py3-none-any.whl" } ], "1.4": [ { "comment_text": "", "digests": { "md5": "fb4373c1a6dd9b8feb1d14516858f00b", "sha256": "68402aae8e22ee6ecfed5565379e3da6e5eb6ba74b0e134237a862b764248e63" }, "downloads": -1, "filename": "api_insee-1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fb4373c1a6dd9b8feb1d14516858f00b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14115, "upload_time": "2019-09-04T09:44:34", "url": "https://files.pythonhosted.org/packages/3c/dc/f126934a2cf34d7c26717423330aea8227d5c270d41725141bff2912febc/api_insee-1.4-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fb4373c1a6dd9b8feb1d14516858f00b", "sha256": "68402aae8e22ee6ecfed5565379e3da6e5eb6ba74b0e134237a862b764248e63" }, "downloads": -1, "filename": "api_insee-1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fb4373c1a6dd9b8feb1d14516858f00b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14115, "upload_time": "2019-09-04T09:44:34", "url": "https://files.pythonhosted.org/packages/3c/dc/f126934a2cf34d7c26717423330aea8227d5c270d41725141bff2912febc/api_insee-1.4-py2.py3-none-any.whl" } ] }