| Name | faqtory JSON |
| Version |
1.1.3
JSON |
| download |
| home_page | |
| Summary | Auto FAQ builder |
| upload_time | 2024-01-31 12:35:51 |
| maintainer | |
| docs_url | None |
| author | Will McGugan |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FAQtory
FAQtory is a tool to auto-generate a [FAQ.md](./FAQ.md) (Frequently Asked Questions) document for your project.
Additionally, a "suggest" feature uses fuzzy matching to reply to GitHub issues with suggestions from your FAQ.
## Getting started
Faqtory is best installed via [pipx](https://github.com/pypa/pipx) to avoid any dependency conflicts:
```bash
pipx install faqtory
```
Run the following from the directory you wish to store the FAQ document.
```bash
faqtory init
```
This will create the following files and directories:
- `faq.yml` A configuration file which you can edit.
- `./.faq/` A directory which will contain templates.
- `./questions/` A directory containing question documents.
## Adding questions
To add questions create a file with the extension `.question.md` in the questions directory (`./questions/` if you are using the defaults).
Question documents are Markdown with front-matter. Here's an example:
```yml
---
title: "What does FAQ stand for?"
alt_titles:
- "What is the meaning of FAQ?"
- "What does FAQ mean?"
---
FAQ stands for *Frequently Asked Questions*
```
The filename is unimportant, but a `title` is mandatory. You can also optionally add alternative titles under `alt_titles` which will be used with the `faqtory suggest` feature (but not displayed).
## Building
Run the following command to build the FAQ:
```bash
faqtory build
```
With the default settings this will generate an [FAQ.md](./FAQ.md) file.
## Suggest
The "suggest" subcommand can compile a list of FAQ entries that match a supplied issue title. Here's an example:
```bash
faqtory suggest "who is the author of FAQtory?"
```
This will generate a list of matching entries from the FAQ, and write Markdown to stdout. You can modify the output with the "suggest.md" template, which you will find in your ".faq/" directory (if you haven't configured it elsewhere),
This feature is designed to be used with a GitHub action to post an automated response. To enable this feature, copy [new_issue.yml](https://github.com/willmcgugan/faqtory/blob/main/.github/workflows/new_issue.yml) to a similarly named directory in your repository.
## Disclaimer
This was a hastily put together tool by a maintainer that was tired of responding to the same old issues. I can't devote much time to this project, but I will happily accept PRs!
Raw data
{
"_id": null,
"home_page": "",
"name": "faqtory",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Will McGugan",
"author_email": "willmcgugan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/51/b4/02695d5b202d17a471cb19478cd2534a7a3a094611d8240cdcf067c8bf8f/faqtory-1.1.3.tar.gz",
"platform": null,
"description": "# FAQtory\n\nFAQtory is a tool to auto-generate a [FAQ.md](./FAQ.md) (Frequently Asked Questions) document for your project.\n\nAdditionally, a \"suggest\" feature uses fuzzy matching to reply to GitHub issues with suggestions from your FAQ.\n\n## Getting started\n\nFaqtory is best installed via [pipx](https://github.com/pypa/pipx) to avoid any dependency conflicts:\n\n```bash\npipx install faqtory\n```\n\nRun the following from the directory you wish to store the FAQ document. \n\n```bash\nfaqtory init\n```\n\nThis will create the following files and directories:\n\n- `faq.yml` A configuration file which you can edit.\n- `./.faq/` A directory which will contain templates.\n- `./questions/` A directory containing question documents.\n\n## Adding questions\n\nTo add questions create a file with the extension `.question.md` in the questions directory (`./questions/` if you are using the defaults).\n\nQuestion documents are Markdown with front-matter. Here's an example:\n\n```yml\n---\ntitle: \"What does FAQ stand for?\"\nalt_titles:\n - \"What is the meaning of FAQ?\"\n - \"What does FAQ mean?\"\n---\n\nFAQ stands for *Frequently Asked Questions*\n```\n\nThe filename is unimportant, but a `title` is mandatory. You can also optionally add alternative titles under `alt_titles` which will be used with the `faqtory suggest` feature (but not displayed).\n\n## Building\n\nRun the following command to build the FAQ:\n\n```bash\nfaqtory build\n```\n\nWith the default settings this will generate an [FAQ.md](./FAQ.md) file.\n\n\n## Suggest\n\nThe \"suggest\" subcommand can compile a list of FAQ entries that match a supplied issue title. Here's an example:\n\n```bash\nfaqtory suggest \"who is the author of FAQtory?\"\n```\n\nThis will generate a list of matching entries from the FAQ, and write Markdown to stdout. You can modify the output with the \"suggest.md\" template, which you will find in your \".faq/\" directory (if you haven't configured it elsewhere),\n\nThis feature is designed to be used with a GitHub action to post an automated response. To enable this feature, copy [new_issue.yml](https://github.com/willmcgugan/faqtory/blob/main/.github/workflows/new_issue.yml) to a similarly named directory in your repository.\n\n\n## Disclaimer\n\nThis was a hastily put together tool by a maintainer that was tired of responding to the same old issues. I can't devote much time to this project, but I will happily accept PRs!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Auto FAQ builder",
"version": "1.1.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "320554a59e3b3fd2cef581468a64a9c3aa950b945890d3bd02aba80ed5bcc64a",
"md5": "11a4d683f71b6becbb98976a2296dcc8",
"sha256": "391c56338334697b9c73b8e463d6b255e23c88d0f5966beff6ddb06f656af665"
},
"downloads": -1,
"filename": "faqtory-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11a4d683f71b6becbb98976a2296dcc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 7438,
"upload_time": "2024-01-31T12:35:50",
"upload_time_iso_8601": "2024-01-31T12:35:50.170710Z",
"url": "https://files.pythonhosted.org/packages/32/05/54a59e3b3fd2cef581468a64a9c3aa950b945890d3bd02aba80ed5bcc64a/faqtory-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51b402695d5b202d17a471cb19478cd2534a7a3a094611d8240cdcf067c8bf8f",
"md5": "7f0f441e764abf18b4d53dc6b0ebf858",
"sha256": "fd8686668e946d371d8cdc4dd43ef861b4018a3cd12314aa7a0fa768805f388a"
},
"downloads": -1,
"filename": "faqtory-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "7f0f441e764abf18b4d53dc6b0ebf858",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 5929,
"upload_time": "2024-01-31T12:35:51",
"upload_time_iso_8601": "2024-01-31T12:35:51.950590Z",
"url": "https://files.pythonhosted.org/packages/51/b4/02695d5b202d17a471cb19478cd2534a7a3a094611d8240cdcf067c8bf8f/faqtory-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 12:35:51",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "faqtory"
}
