Name | docs-maker JSON |
Version |
1.0.0.dev4
JSON |
| download |
home_page | None |
Summary | Documents Maker |
upload_time | 2024-10-08 21:22:34 |
maintainer | None |
docs_url | None |
author | Roman |
requires_python | <4.0,>=3.9 |
license | None |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# docs-maker
docs-maker — это удобный и мощный инструмент для автоматизации создания документов. С его помощью можно быстро и легко генерировать различные документы, используя шаблоны и интеграции. Подходит как для личных, так и для профессиональных проектов, где требуется гибкость и масштабируемость в создании документации.
Основные возможности:
- Генерация документов на основе пользовательских шаблонов.
- Поддержка различных форматов вывода.
- Интуитивно понятный графический интерфейс.
- Легкость в интеграции с другими системами и приложениями.
## Быстрый старт:
### Сборка
Для начала выполните сборку проекта:
~~~
poetry build
~~~
### Установка
Чтобы установить docs-maker, выполните команду:
~~~
pip install .
~~~
### Запуск
После установки запустите программу:
~~~
docs-maker
~~~
Для получения справки по командам и возможностям используйте:
~~~
docs-maker --help
~~~
### Запуск тестов
Чтобы запустить тесты, выполните команду:
~~~
python -m pytest tests
~~~
### Графический интерфейс (GUI)
Для работы с графическим интерфейсом программы можно использовать одну из команд:
~~~
docs-maker gui
~~~
или
~~~
python -m docs_maker gui
~~~
или
~~~
python -m docs_maker_gui
~~~
Raw data
{
"_id": null,
"home_page": null,
"name": "docs-maker",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Roman",
"author_email": "rabalan83@main.ru",
"download_url": "https://files.pythonhosted.org/packages/e6/20/9c04c1df173c775ed2d1f3b627ce32e33b2bab79ec8e5a52f1a06721243f/docs_maker-1.0.0.dev4.tar.gz",
"platform": null,
"description": "# docs-maker\n\ndocs-maker \u2014 \u044d\u0442\u043e \u0443\u0434\u043e\u0431\u043d\u044b\u0439 \u0438 \u043c\u043e\u0449\u043d\u044b\u0439 \u0438\u043d\u0441\u0442\u0440\u0443\u043c\u0435\u043d\u0442 \u0434\u043b\u044f \u0430\u0432\u0442\u043e\u043c\u0430\u0442\u0438\u0437\u0430\u0446\u0438\u0438 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u043e\u0432. \u0421 \u0435\u0433\u043e \u043f\u043e\u043c\u043e\u0449\u044c\u044e \u043c\u043e\u0436\u043d\u043e \u0431\u044b\u0441\u0442\u0440\u043e \u0438 \u043b\u0435\u0433\u043a\u043e \u0433\u0435\u043d\u0435\u0440\u0438\u0440\u043e\u0432\u0430\u0442\u044c \u0440\u0430\u0437\u043b\u0438\u0447\u043d\u044b\u0435 \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u044b, \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u044f \u0448\u0430\u0431\u043b\u043e\u043d\u044b \u0438 \u0438\u043d\u0442\u0435\u0433\u0440\u0430\u0446\u0438\u0438. \u041f\u043e\u0434\u0445\u043e\u0434\u0438\u0442 \u043a\u0430\u043a \u0434\u043b\u044f \u043b\u0438\u0447\u043d\u044b\u0445, \u0442\u0430\u043a \u0438 \u0434\u043b\u044f \u043f\u0440\u043e\u0444\u0435\u0441\u0441\u0438\u043e\u043d\u0430\u043b\u044c\u043d\u044b\u0445 \u043f\u0440\u043e\u0435\u043a\u0442\u043e\u0432, \u0433\u0434\u0435 \u0442\u0440\u0435\u0431\u0443\u0435\u0442\u0441\u044f \u0433\u0438\u0431\u043a\u043e\u0441\u0442\u044c \u0438 \u043c\u0430\u0441\u0448\u0442\u0430\u0431\u0438\u0440\u0443\u0435\u043c\u043e\u0441\u0442\u044c \u0432 \u0441\u043e\u0437\u0434\u0430\u043d\u0438\u0438 \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u0430\u0446\u0438\u0438.\n\u041e\u0441\u043d\u043e\u0432\u043d\u044b\u0435 \u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u0438:\n\n- \u0413\u0435\u043d\u0435\u0440\u0430\u0446\u0438\u044f \u0434\u043e\u043a\u0443\u043c\u0435\u043d\u0442\u043e\u0432 \u043d\u0430 \u043e\u0441\u043d\u043e\u0432\u0435 \u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u044c\u0441\u043a\u0438\u0445 \u0448\u0430\u0431\u043b\u043e\u043d\u043e\u0432.\n- \u041f\u043e\u0434\u0434\u0435\u0440\u0436\u043a\u0430 \u0440\u0430\u0437\u043b\u0438\u0447\u043d\u044b\u0445 \u0444\u043e\u0440\u043c\u0430\u0442\u043e\u0432 \u0432\u044b\u0432\u043e\u0434\u0430.\n- \u0418\u043d\u0442\u0443\u0438\u0442\u0438\u0432\u043d\u043e \u043f\u043e\u043d\u044f\u0442\u043d\u044b\u0439 \u0433\u0440\u0430\u0444\u0438\u0447\u0435\u0441\u043a\u0438\u0439 \u0438\u043d\u0442\u0435\u0440\u0444\u0435\u0439\u0441.\n- \u041b\u0435\u0433\u043a\u043e\u0441\u0442\u044c \u0432 \u0438\u043d\u0442\u0435\u0433\u0440\u0430\u0446\u0438\u0438 \u0441 \u0434\u0440\u0443\u0433\u0438\u043c\u0438 \u0441\u0438\u0441\u0442\u0435\u043c\u0430\u043c\u0438 \u0438 \u043f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u044f\u043c\u0438.\n\n## \u0411\u044b\u0441\u0442\u0440\u044b\u0439 \u0441\u0442\u0430\u0440\u0442:\n### \u0421\u0431\u043e\u0440\u043a\u0430\n\u0414\u043b\u044f \u043d\u0430\u0447\u0430\u043b\u0430 \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u0435 \u0441\u0431\u043e\u0440\u043a\u0443 \u043f\u0440\u043e\u0435\u043a\u0442\u0430:\n~~~\npoetry build\n~~~\n\n### \u0423\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0430\n\u0427\u0442\u043e\u0431\u044b \u0443\u0441\u0442\u0430\u043d\u043e\u0432\u0438\u0442\u044c docs-maker, \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u0443:\n~~~\npip install .\n~~~\n### \u0417\u0430\u043f\u0443\u0441\u043a\n\u041f\u043e\u0441\u043b\u0435 \u0443\u0441\u0442\u0430\u043d\u043e\u0432\u043a\u0438 \u0437\u0430\u043f\u0443\u0441\u0442\u0438\u0442\u0435 \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u0443:\n~~~\ndocs-maker\n~~~\n\u0414\u043b\u044f \u043f\u043e\u043b\u0443\u0447\u0435\u043d\u0438\u044f \u0441\u043f\u0440\u0430\u0432\u043a\u0438 \u043f\u043e \u043a\u043e\u043c\u0430\u043d\u0434\u0430\u043c \u0438 \u0432\u043e\u0437\u043c\u043e\u0436\u043d\u043e\u0441\u0442\u044f\u043c \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u0443\u0439\u0442\u0435:\n~~~\ndocs-maker --help\n~~~\n\n### \u0417\u0430\u043f\u0443\u0441\u043a \u0442\u0435\u0441\u0442\u043e\u0432\n\u0427\u0442\u043e\u0431\u044b \u0437\u0430\u043f\u0443\u0441\u0442\u0438\u0442\u044c \u0442\u0435\u0441\u0442\u044b, \u0432\u044b\u043f\u043e\u043b\u043d\u0438\u0442\u0435 \u043a\u043e\u043c\u0430\u043d\u0434\u0443:\n~~~\npython -m pytest tests\n~~~\n\n### \u0413\u0440\u0430\u0444\u0438\u0447\u0435\u0441\u043a\u0438\u0439 \u0438\u043d\u0442\u0435\u0440\u0444\u0435\u0439\u0441 (GUI)\n\u0414\u043b\u044f \u0440\u0430\u0431\u043e\u0442\u044b \u0441 \u0433\u0440\u0430\u0444\u0438\u0447\u0435\u0441\u043a\u0438\u043c \u0438\u043d\u0442\u0435\u0440\u0444\u0435\u0439\u0441\u043e\u043c \u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u044b \u043c\u043e\u0436\u043d\u043e \u0438\u0441\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u044c \u043e\u0434\u043d\u0443 \u0438\u0437 \u043a\u043e\u043c\u0430\u043d\u0434:\n~~~\ndocs-maker gui\n~~~\n\u0438\u043b\u0438\n\n~~~\npython -m docs_maker gui\n~~~\n\u0438\u043b\u0438\n~~~\npython -m docs_maker_gui\n~~~\n",
"bugtrack_url": null,
"license": null,
"summary": "Documents Maker",
"version": "1.0.0.dev4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cab753573b28cfeed89ff4347a53dd80d269bab42a5c4fdbaa3cd94675a3b539",
"md5": "5dd461c0d6b4dce783d86f3b96fa46a9",
"sha256": "956356cf31160bea8fd02e3679a8ee0f0d7b3cd0f666c3b6f02424e6f8da05db"
},
"downloads": -1,
"filename": "docs_maker-1.0.0.dev4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5dd461c0d6b4dce783d86f3b96fa46a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 23004,
"upload_time": "2024-10-08T21:22:33",
"upload_time_iso_8601": "2024-10-08T21:22:33.339242Z",
"url": "https://files.pythonhosted.org/packages/ca/b7/53573b28cfeed89ff4347a53dd80d269bab42a5c4fdbaa3cd94675a3b539/docs_maker-1.0.0.dev4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6209c04c1df173c775ed2d1f3b627ce32e33b2bab79ec8e5a52f1a06721243f",
"md5": "8aa96c7d5f8d06c59c50b7d9768cc4a6",
"sha256": "63abf554ef2277b7f1a49502a20d59b59cf1af0de714712da4847bd13f06d8a7"
},
"downloads": -1,
"filename": "docs_maker-1.0.0.dev4.tar.gz",
"has_sig": false,
"md5_digest": "8aa96c7d5f8d06c59c50b7d9768cc4a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 13784,
"upload_time": "2024-10-08T21:22:34",
"upload_time_iso_8601": "2024-10-08T21:22:34.513649Z",
"url": "https://files.pythonhosted.org/packages/e6/20/9c04c1df173c775ed2d1f3b627ce32e33b2bab79ec8e5a52f1a06721243f/docs_maker-1.0.0.dev4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 21:22:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "docs-maker"
}