| Name | docchain JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-05-13 03:33:47 |
| maintainer | |
| docs_url | None |
| author | Artem Kolesnikov |
| requires_python | >=3.10,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DocChain
This package can be used to generate complex structured documents from Specs using LLMm models.
`Document` is an abstraction that represent generated data, e.g. it could be any text data in
markdown or HTML, configuration in JSON, YAML or other formats, Python objects or classes, or any
other data that can be generated by LLMs.
`Spec` contains document requirements. It holds general information about the generated document.
`Section` is a composite part of a Document. Document itself is a Section. Such design allows
inclusion of Documents inside another documents.
`Generator` generates Document from the provided Spec. Each generator can be configured with a list
of steps that are executed before or after generation.
`Middleware` is a callable that can modify Spec or the generated Documents. It acts the same as
middleware in an HTTP framework, it can be used for variety of tasks. E.g. transforming, formatting
or linting generated document ot its parts.
## TODO
- [ ] Store stats in an SQLite database.
- [ ] Blocks for HTML, Markdown, Python, one line Python, templates.
- [ ] Add middleware to plan steps.
Raw data
{
"_id": null,
"home_page": "",
"name": "docchain",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Artem Kolesnikov",
"author_email": "tyomo4ka@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ce/75/e8f303eab72699fedacdee8b33b407df659bada75909a02984cae988d516/docchain-0.0.7.tar.gz",
"platform": null,
"description": "# DocChain\n\nThis package can be used to generate complex structured documents from Specs using LLMm models.\n\n`Document` is an abstraction that represent generated data, e.g. it could be any text data in\nmarkdown or HTML, configuration in JSON, YAML or other formats, Python objects or classes, or any\nother data that can be generated by LLMs.\n\n`Spec` contains document requirements. It holds general information about the generated document.\n\n`Section` is a composite part of a Document. Document itself is a Section. Such design allows\ninclusion of Documents inside another documents.\n\n`Generator` generates Document from the provided Spec. Each generator can be configured with a list\nof steps that are executed before or after generation.\n\n`Middleware` is a callable that can modify Spec or the generated Documents. It acts the same as\nmiddleware in an HTTP framework, it can be used for variety of tasks. E.g. transforming, formatting\nor linting generated document ot its parts.\n\n## TODO\n\n- [ ] Store stats in an SQLite database.\n- [ ] Blocks for HTML, Markdown, Python, one line Python, templates.\n- [ ] Add middleware to plan steps.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.0.7",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "455ae91e836c27e4d04ff065ed291c751ce4a274d01335d91712b0aa9f0244a5",
"md5": "b69809a631603693230fec5137667b1f",
"sha256": "a28e36d68e60c8ac4cb3346589fbc270767f5c1b095b23aca7a5635d98f077f5"
},
"downloads": -1,
"filename": "docchain-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b69809a631603693230fec5137667b1f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 12882,
"upload_time": "2023-05-13T03:33:45",
"upload_time_iso_8601": "2023-05-13T03:33:45.985235Z",
"url": "https://files.pythonhosted.org/packages/45/5a/e91e836c27e4d04ff065ed291c751ce4a274d01335d91712b0aa9f0244a5/docchain-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ce75e8f303eab72699fedacdee8b33b407df659bada75909a02984cae988d516",
"md5": "f2ec52eb3100faca9c81da84e0690dd5",
"sha256": "a6c24772d7b4d350edc37f96581ff1097ab4efea545787e5ad5994206868ca16"
},
"downloads": -1,
"filename": "docchain-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "f2ec52eb3100faca9c81da84e0690dd5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 7520,
"upload_time": "2023-05-13T03:33:47",
"upload_time_iso_8601": "2023-05-13T03:33:47.589262Z",
"url": "https://files.pythonhosted.org/packages/ce/75/e8f303eab72699fedacdee8b33b407df659bada75909a02984cae988d516/docchain-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-13 03:33:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "docchain"
}
