Name | flyteidl JSON |
Version |
1.11.0
JSON |
| download |
home_page | |
Summary | IDL for Flyte Platform |
upload_time | 2024-03-12 04:23:01 |
maintainer | |
docs_url | None |
author | |
requires_python | <3.13,>=3.8 |
license | Apache-2.0 |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# Flyteidl
This is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).
[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
* [flyte.org](https://flyte.org)
* [Flyte Docs](http://docs.flyte.org)
* [Flyteidl API reference documentation](https://docs.flyte.org/en/latest/reference_flyteidl.html)
## Contributing to Flyteidl
## Tooling for Flyteidl
1. Run ``make download_tooling`` to install generator dependencies.
```bash
make download_tooling
```
2. Ensure Docker is installed locally.
3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
```bash
make generate
```
4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
```bash
make doc-requirements.txt
```
## Docs structure
The index.rst files for protos are arranged in parallel under the ``docs`` folder.
All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
```
docs
├── admin
│ ├── admin.rst
│ └── index.rst
├── core
│ ├── core.rst
│ └── index.rst
├── datacatalog
│ ├── datacatalog.rst
│ └── index.rst
├── event
│ ├── event.rst
│ └── index.rst
├── plugins
│ ├── index.rst
│ └── plugins.rst
├── service
│ ├── index.rst
│ └── service.rst
```
Each module in protos has a module in docs with the same name.
For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
## Generating Documentation
* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
```
core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
# Remove any currently generated file
ls -d protos/docs/core/* | grep -v index.rst | xargs rm
protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
```
* ``make generate`` generates the modified rst files.
* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
Raw data
{
"_id": null,
"home_page": "",
"name": "flyteidl",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Flyte Contributors <admin@flyte.org>",
"download_url": "https://files.pythonhosted.org/packages/a4/c0/7712021c25cdafb2b0a8106d67774d899efa05ce258642ba2719c1c30269/flyteidl-1.11.0.tar.gz",
"platform": null,
"description": "# Flyteidl\n\nThis is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).\n\n\n[![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)\n\n* [flyte.org](https://flyte.org)\n* [Flyte Docs](http://docs.flyte.org)\n* [Flyteidl API reference documentation](https://docs.flyte.org/en/latest/reference_flyteidl.html)\n\n## Contributing to Flyteidl\n\n## Tooling for Flyteidl\n\n1. Run ``make download_tooling`` to install generator dependencies.\n\n```bash\n make download_tooling\n```\n\n2. Ensure Docker is installed locally.\n3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.\n\n```bash\n make generate\n```\n\n4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run\n\n```bash\n make doc-requirements.txt\n```\n\n## Docs structure\n\nThe index.rst files for protos are arranged in parallel under the ``docs`` folder.\nAll the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.\n\n```\ndocs\n\u251c\u2500\u2500 admin\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 admin.rst\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 index.rst\n\u251c\u2500\u2500 core\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 core.rst\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 index.rst\n\u251c\u2500\u2500 datacatalog\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 datacatalog.rst\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 index.rst\n\u251c\u2500\u2500 event\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 event.rst\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 index.rst\n\u251c\u2500\u2500 plugins\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 index.rst\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 plugins.rst\n\u251c\u2500\u2500 service\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 index.rst\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 service.rst\n```\n\nEach module in protos has a module in docs with the same name.\nFor example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.\n\n\n## Generating Documentation\n\n* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.\n```\n core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`\n # Remove any currently generated file\n ls -d protos/docs/core/* | grep -v index.rst | xargs rm\n protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`\n```\n\n* ``make generate`` generates the modified rst files.\n\n* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "IDL for Flyte Platform",
"version": "1.11.0",
"project_urls": {
"Homepage": "https://github.com/flyteorg/flyte/tree/master/flyteidl"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ce9f9ee1505144bfdcb272d5de7f29e9c8daf20204fa0234e57b203f2c7b491",
"md5": "7987d897284a78678802071689ff7ce0",
"sha256": "957f986e9904740a46048285c861e077fdff8bf7ba088d4b2bbe25f2b9aee0cf"
},
"downloads": -1,
"filename": "flyteidl-1.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7987d897284a78678802071689ff7ce0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 211904,
"upload_time": "2024-03-12T04:22:58",
"upload_time_iso_8601": "2024-03-12T04:22:58.202776Z",
"url": "https://files.pythonhosted.org/packages/0c/e9/f9ee1505144bfdcb272d5de7f29e9c8daf20204fa0234e57b203f2c7b491/flyteidl-1.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4c07712021c25cdafb2b0a8106d67774d899efa05ce258642ba2719c1c30269",
"md5": "ae17faa3f299dae9ce4d4be3ce98d930",
"sha256": "1cd723a8bbb767d03e61219d97500bbf18d4839cb1f5b58bbe7a1dc154311e10"
},
"downloads": -1,
"filename": "flyteidl-1.11.0.tar.gz",
"has_sig": false,
"md5_digest": "ae17faa3f299dae9ce4d4be3ce98d930",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 117639,
"upload_time": "2024-03-12T04:23:01",
"upload_time_iso_8601": "2024-03-12T04:23:01.735421Z",
"url": "https://files.pythonhosted.org/packages/a4/c0/7712021c25cdafb2b0a8106d67774d899efa05ce258642ba2719c1c30269/flyteidl-1.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 04:23:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flyteorg",
"github_project": "flyte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flyteidl"
}