| Name | konbinine JSON |
| Version |
0.3.10
JSON |
| download |
| home_page | https://github.com/hueyyeng/konbini |
| Summary | Opinionated Autodesk Shotgun/ShotGrid API Wrapper. |
| upload_time | 2024-12-11 02:14:50 |
| maintainer | Huey Yeng |
| docs_url | None |
| author | Huey Yeng |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Huey Yeng 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. |
| keywords |
python
library
shotgrid
shotgun
api
autodesk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
shotgun-api3
requests
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# konbini
[](https://badge.fury.io/py/konbinine)
おまえはもうショットいる。なに？！
Opinionated wrapper for Autodesk ~~~Shotgun~~~ ~~~ShotGrid~~~ I
mean [Flow Production Tracking Python API](https://github.com/shotgunsoftware/python-api)
because the API usage requirements is 便利じゃないでしょう？
> コンビニね～ As there is an existing PyPI project using **_konbini_** name, this repo project name
> on PyPI will be **konbinine**.
## How to Use
> For Python 3.8 and newer! While Autodesk made **shotgun_api3** to be compatible with Python 2 and 3, **konbinine**
> uses `dataclass` that is only available in Python 3.7 onwards. Starting with v0.1.6, Python 3.8 will be the minimum
> version due to the usage of TypedDict.
**konbinine** is designed to be used with web framework (such as Django, Flask, etc.) that interacts with ShotGrid. This
library has not been tested inside Digital Content Creation (DCC) software such as Maya, 3ds Max or Houdini.
Technically it should just work but that is outside the scope of this library.
### New Project
#### First time setup
1. Add `konbinine` to your project's `requirements.txt`.
2. ???
3. Profit (in improving code readability and debugging)
#### Using konbinine
I recommend configuring the environment variables before running the following code.
Set it using your `.env` file or through the shell session etc.
```shell
# if your studio subscribed to Shotgun prior to the ShotGrid rename, the URL should
# looks like https://yourstudioname.shotgunstudio.com or something
KONBINI_BASE_URL=https://yourstudioname.shotgrid.autodesk.com
KONBINI_SCRIPT_NAME=YOURSHOTGRIDAPISCRIPTNAMEHERE
KONBINI_API_KEY=YOURSHOTGRIDAPIKEYHERE
```
```python
from konbinine import Konbini
from konbinine.enums import SgEntity
kon = Konbini()
booking_schemas = kon.get_sg_entity_schema_fields(SgEntity.BOOKING)
# whatever booking schemas results here
```
### Existing Project that Uses shotgun_api3
You will need to... rewrite/refactor your code to use **konbinine**! Pretty much the main reason why **konbinine** was
created is to improve the Developer Experience (DX) when interacting with ShotGrid.
## Quickstart for Developers
```commandline
pip install -r requirements.txt
```
## Documentation
For now, refer to the docstring in the source code. Generally this is not meant to outright replace `shotgun_api3` and
there is some attributes that are intentionally missing as I don't use it (or yet to use it).
## Extending konbinine
Coming soon!
Raw data
{
"_id": null,
"home_page": "https://github.com/hueyyeng/konbini",
"name": "konbinine",
"maintainer": "Huey Yeng",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Huey Yeng <huey.yeng.mmu@gmail.com>",
"keywords": "python, library, shotgrid, shotgun, api, autodesk",
"author": "Huey Yeng",
"author_email": "Huey Yeng <huey.yeng.mmu@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/58/17/2fad01108a20ec6bccbd0573fe310064d5e0263da2ab874e8340bdc678d0/konbinine-0.3.10.tar.gz",
"platform": null,
"description": "# konbini\n\n[](https://badge.fury.io/py/konbinine)\n\n\u304a\u307e\u3048\u306f\u3082\u3046\u30b7\u30e7\u30c3\u30c8\u3044\u308b\u3002\u306a\u306b\uff1f\uff01\n\nOpinionated wrapper for Autodesk ~~~Shotgun~~~ ~~~ShotGrid~~~ I\nmean [Flow Production Tracking Python API](https://github.com/shotgunsoftware/python-api)\nbecause the API usage requirements is \u4fbf\u5229\u3058\u3083\u306a\u3044\u3067\u3057\u3087\u3046\uff1f\n\n> \u30b3\u30f3\u30d3\u30cb\u306d\uff5e As there is an existing PyPI project using **_konbini_** name, this repo project name\n> on PyPI will be **konbinine**.\n\n## How to Use\n\n> For Python 3.8 and newer! While Autodesk made **shotgun_api3** to be compatible with Python 2 and 3, **konbinine**\n> uses `dataclass` that is only available in Python 3.7 onwards. Starting with v0.1.6, Python 3.8 will be the minimum\n> version due to the usage of TypedDict.\n\n**konbinine** is designed to be used with web framework (such as Django, Flask, etc.) that interacts with ShotGrid. This\nlibrary has not been tested inside Digital Content Creation (DCC) software such as Maya, 3ds Max or Houdini.\n\nTechnically it should just work but that is outside the scope of this library.\n\n### New Project\n\n#### First time setup\n\n1. Add `konbinine` to your project's `requirements.txt`.\n2. ???\n3. Profit (in improving code readability and debugging)\n\n#### Using konbinine\n\nI recommend configuring the environment variables before running the following code.\n\nSet it using your `.env` file or through the shell session etc.\n\n```shell\n# if your studio subscribed to Shotgun prior to the ShotGrid rename, the URL should\n# looks like https://yourstudioname.shotgunstudio.com or something \nKONBINI_BASE_URL=https://yourstudioname.shotgrid.autodesk.com\nKONBINI_SCRIPT_NAME=YOURSHOTGRIDAPISCRIPTNAMEHERE\nKONBINI_API_KEY=YOURSHOTGRIDAPIKEYHERE\n```\n\n```python\nfrom konbinine import Konbini\nfrom konbinine.enums import SgEntity\n\nkon = Konbini()\nbooking_schemas = kon.get_sg_entity_schema_fields(SgEntity.BOOKING)\n# whatever booking schemas results here\n```\n\n### Existing Project that Uses shotgun_api3\n\nYou will need to... rewrite/refactor your code to use **konbinine**! Pretty much the main reason why **konbinine** was\ncreated is to improve the Developer Experience (DX) when interacting with ShotGrid.\n\n## Quickstart for Developers\n\n```commandline\npip install -r requirements.txt\n```\n\n## Documentation\n\nFor now, refer to the docstring in the source code. Generally this is not meant to outright replace `shotgun_api3` and\nthere is some attributes that are intentionally missing as I don't use it (or yet to use it).\n\n## Extending konbinine\n\nComing soon!\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Huey Yeng 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. ",
"summary": "Opinionated Autodesk Shotgun/ShotGrid API Wrapper.",
"version": "0.3.10",
"project_urls": {
"Bug Reports": "https://github.com/hueyyeng/konbini/issues",
"Homepage": "https://github.com/hueyyeng/konbini",
"Source": "https://github.com/hueyyeng/konbini"
},
"split_keywords": [
"python",
" library",
" shotgrid",
" shotgun",
" api",
" autodesk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6703034ecb4720c9595bc9fc6ae30431a3d64e9cd929fb2b70d5f1318e482609",
"md5": "3259b58ed876b1b23edc2ae4bd357eec",
"sha256": "257c3ba78afaaee6cb52e97c17c02b61f8067631c4d9bbc3b61990014bd3fbd2"
},
"downloads": -1,
"filename": "konbinine-0.3.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3259b58ed876b1b23edc2ae4bd357eec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23058,
"upload_time": "2024-12-11T02:14:48",
"upload_time_iso_8601": "2024-12-11T02:14:48.701283Z",
"url": "https://files.pythonhosted.org/packages/67/03/034ecb4720c9595bc9fc6ae30431a3d64e9cd929fb2b70d5f1318e482609/konbinine-0.3.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58172fad01108a20ec6bccbd0573fe310064d5e0263da2ab874e8340bdc678d0",
"md5": "cf4839f31be4cd1e61d15562703735ca",
"sha256": "f5d2a8bf68c8b8d2b900e0b8c9c54e8c5ce5b021a681276abb8cf161fcce7e9b"
},
"downloads": -1,
"filename": "konbinine-0.3.10.tar.gz",
"has_sig": false,
"md5_digest": "cf4839f31be4cd1e61d15562703735ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 23264,
"upload_time": "2024-12-11T02:14:50",
"upload_time_iso_8601": "2024-12-11T02:14:50.102810Z",
"url": "https://files.pythonhosted.org/packages/58/17/2fad01108a20ec6bccbd0573fe310064d5e0263da2ab874e8340bdc678d0/konbinine-0.3.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 02:14:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hueyyeng",
"github_project": "konbini",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "shotgun-api3",
"specs": [
[
">=",
"3.2.6"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.28.0"
]
]
}
],
"lcname": "konbinine"
}
