Open Source Licenses API
============
Open Source Licenses is a simple tool for getting information on open source licenses. It returns information on various open source licenses.
This is a Python API Wrapper for the [Open Source Licenses API](https://apiverve.com/marketplace/api/openlicenses)
---
## Installation
pip install apiverve-opensourcelicenses
---
## Configuration
Before using the openlicenses API client, you have to setup your account and obtain your API Key.
You can get it by signing up at [https://apiverve.com](https://apiverve.com)
---
## Usage
The Open Source Licenses API documentation is found here: [https://docs.apiverve.com/api/openlicenses](https://docs.apiverve.com/api/openlicenses).
You can find parameters, example responses, and status codes documented here.
### Setup
```
# Import the client module
from apiverve_opensourcelicenses.apiClient import OpenlicensesAPIClient
# Initialize the client with your APIVerve API key
api = OpenlicensesAPIClient("[YOUR_API_KEY]")
```
---
### Perform Request
Using the API client, you can perform requests to the API.
###### Define Query
```
query = { "name": "MIT" }
```
###### Simple Request
```
# Make a request to the API
result = api.execute(query)
# Print the result
print(result)
```
###### Example Response
```
{
"status": "ok",
"error": null,
"data": {
"domain_content": false,
"domain_data": false,
"domain_software": true,
"legacy_ids": [
"mit-license"
],
"license": "MIT",
"name": "MIT License",
"license_url": "https://opensource.org/licenses/MIT",
"license_status": "active"
},
"code": 200
}
```
---
## Customer Support
Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
---
## Updates
Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
---
## Legal
All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
---
## License
Licensed under the The MIT License (MIT)
Copyright (©) 2024 APIVerve, and Evlar LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "apiverve-opensourcelicenses",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "open source licenses, open source licenses api, open source licenses tool, open source licenses software, open source licenses service",
"author": null,
"author_email": "APIVerve <hello@apiverve.com>",
"download_url": "https://files.pythonhosted.org/packages/74/aa/3bdb4027d28dd603131e16ad9600e00d0e50cf5366ba6b95a96e5819e7ea/apiverve_opensourcelicenses-1.1.5.tar.gz",
"platform": null,
"description": "Open Source Licenses API\r\n============\r\n\r\nOpen Source Licenses is a simple tool for getting information on open source licenses. It returns information on various open source licenses.\r\n\r\n\r\n\r\n\r\n\r\nThis is a Python API Wrapper for the [Open Source Licenses API](https://apiverve.com/marketplace/api/openlicenses)\r\n\r\n---\r\n\r\n## Installation\r\n\tpip install apiverve-opensourcelicenses\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the openlicenses API client, you have to setup your account and obtain your API Key. \r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com)\r\n\r\n---\r\n\r\n## Usage\r\n\r\nThe Open Source Licenses API documentation is found here: [https://docs.apiverve.com/api/openlicenses](https://docs.apiverve.com/api/openlicenses). \r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```\r\n# Import the client module\r\nfrom apiverve_opensourcelicenses.apiClient import OpenlicensesAPIClient\r\n\r\n# Initialize the client with your APIVerve API key\r\napi = OpenlicensesAPIClient(\"[YOUR_API_KEY]\")\r\n```\r\n\r\n---\r\n\r\n\r\n### Perform Request\r\nUsing the API client, you can perform requests to the API.\r\n\r\n###### Define Query\r\n\r\n```\r\nquery = { \"name\": \"MIT\" }\r\n```\r\n\r\n###### Simple Request\r\n\r\n```\r\n# Make a request to the API\r\nresult = api.execute(query)\r\n\r\n# Print the result\r\nprint(result)\r\n```\r\n\r\n###### Example Response\r\n\r\n```\r\n{\r\n \"status\": \"ok\",\r\n \"error\": null,\r\n \"data\": {\r\n \"domain_content\": false,\r\n \"domain_data\": false,\r\n \"domain_software\": true,\r\n \"legacy_ids\": [\r\n \"mit-license\"\r\n ],\r\n \"license\": \"MIT\",\r\n \"name\": \"MIT License\",\r\n \"license_url\": \"https://opensource.org/licenses/MIT\",\r\n \"license_status\": \"active\"\r\n },\r\n \"code\": 200\r\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).\r\n\r\n---\r\n\r\n## Updates\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2024 APIVerve, and Evlar LLC\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Open Source Licenses is a simple tool for getting information on open source licenses. It returns information on various open source licenses.",
"version": "1.1.5",
"project_urls": {
"Documentation": "https://docs.apiverve.com/api/openlicenses?utm_source=pypi",
"Homepage": "https://apiverve.com?utm_source=pypi",
"Repository": "https://github.com/apiverve/openlicenses.Python-API",
"Twitter": "https://twitter.com/apivervehq"
},
"split_keywords": [
"open source licenses",
" open source licenses api",
" open source licenses tool",
" open source licenses software",
" open source licenses service"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0fc2ac99af827c8323af74e68a874959c7024315a78e6356b2218dd401557740",
"md5": "a6860b8c00e4459d681eb7c1e7f9ce0e",
"sha256": "4828277dc4babd8410d0addfebbdab74549163390a4c9d7add28cdb79d81e10d"
},
"downloads": -1,
"filename": "apiverve_opensourcelicenses-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6860b8c00e4459d681eb7c1e7f9ce0e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 7444,
"upload_time": "2024-09-21T06:53:18",
"upload_time_iso_8601": "2024-09-21T06:53:18.260364Z",
"url": "https://files.pythonhosted.org/packages/0f/c2/ac99af827c8323af74e68a874959c7024315a78e6356b2218dd401557740/apiverve_opensourcelicenses-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74aa3bdb4027d28dd603131e16ad9600e00d0e50cf5366ba6b95a96e5819e7ea",
"md5": "67dfe35839e7696ef9febae2dd4d7717",
"sha256": "b9a7c6414a327bb2f4cb00c51a78bf4f2268c882fd668cd57ffdb383351e0887"
},
"downloads": -1,
"filename": "apiverve_opensourcelicenses-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "67dfe35839e7696ef9febae2dd4d7717",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 7013,
"upload_time": "2024-09-21T06:53:19",
"upload_time_iso_8601": "2024-09-21T06:53:19.565268Z",
"url": "https://files.pythonhosted.org/packages/74/aa/3bdb4027d28dd603131e16ad9600e00d0e50cf5366ba6b95a96e5819e7ea/apiverve_opensourcelicenses-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 06:53:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apiverve",
"github_project": "openlicenses.Python-API",
"github_not_found": true,
"lcname": "apiverve-opensourcelicenses"
}
JSON
