[](https://badge.fury.io/py/TaskFeasibilityAnalyzer)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/taskfeasibilityanalyzer)
# TaskFeasibilityAnalyzer
`TaskFeasibilityAnalyzer` is a Python package designed to determine the feasibility of coding tasks using GPT-3. It provides a probability score indicating whether a task can be completed successfully based on the project's structure, technology stack, and any other provided details.
## Installation
To install `TaskFeasibilityAnalyzer`, you can use pip:
```bash
pip install TaskFeasibilityAnalyzer
```
## Usage
### As a Python Module
`TaskFeasibilityAnalyzer` can be used as a Python module in your scripts.
#### Analyzing a Task's Feasibility
```python
from taskfeasibilityanalyzer import TaskFeasibilityAnalyzer
# Initialize the analyzer with the target directory, OpenAI API key, and optionally the project structure and languages
analyzer = TaskFeasibilityAnalyzer(
directory='/path/to/your/project',
openai_api_key='your-openai-api-key',
project_structure='your-project-structure', # Optional
project_languages='languages-used-in-your-project' # Optional
)
# Analyze a task and get a probability score
task_description = "Refactor the database schema to improve performance."
probability = analyzer.analyze_task(task_description)
print(f"The probability that the task can be completed successfully is {probability:.2f}")
```
## Features
- **Integrates with GPT-3**: Leverages the power of GPT-3 to analyze the complexity and requirements of coding tasks.
- **Flexible Project Analysis**: Optionally uses ProjectStructoR or provided details to understand the project's structure and technology stack.
- **Probability Score**: Provides a numerical estimate indicating the feasibility of completing a task.
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/TaskFeasibilityAnalyzer/issues).
## License
This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).
Raw data
{
"_id": null,
"home_page": "https://github.com/chigwell/TaskFeasibilityAnalyzer",
"name": "TaskFeasibilityAnalyzer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/8b/d711455c4a3e3b84bce38a74b11fcef17f519280c60e071500a8a588ccbf/TaskFeasibilityAnalyzer-0.0.9.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/TaskFeasibilityAnalyzer)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/taskfeasibilityanalyzer)\n\n# TaskFeasibilityAnalyzer\n\n`TaskFeasibilityAnalyzer` is a Python package designed to determine the feasibility of coding tasks using GPT-3. It provides a probability score indicating whether a task can be completed successfully based on the project's structure, technology stack, and any other provided details.\n\n## Installation\n\nTo install `TaskFeasibilityAnalyzer`, you can use pip:\n\n```bash\npip install TaskFeasibilityAnalyzer\n```\n\n## Usage\n\n### As a Python Module\n\n`TaskFeasibilityAnalyzer` can be used as a Python module in your scripts.\n\n#### Analyzing a Task's Feasibility\n\n```python\nfrom taskfeasibilityanalyzer import TaskFeasibilityAnalyzer\n\n# Initialize the analyzer with the target directory, OpenAI API key, and optionally the project structure and languages\nanalyzer = TaskFeasibilityAnalyzer(\n directory='/path/to/your/project', \n openai_api_key='your-openai-api-key',\n project_structure='your-project-structure', # Optional\n project_languages='languages-used-in-your-project' # Optional\n)\n\n# Analyze a task and get a probability score\ntask_description = \"Refactor the database schema to improve performance.\"\nprobability = analyzer.analyze_task(task_description)\nprint(f\"The probability that the task can be completed successfully is {probability:.2f}\")\n```\n\n## Features\n\n- **Integrates with GPT-3**: Leverages the power of GPT-3 to analyze the complexity and requirements of coding tasks.\n- **Flexible Project Analysis**: Optionally uses ProjectStructoR or provided details to understand the project's structure and technology stack.\n- **Probability Score**: Provides a numerical estimate indicating the feasibility of completing a task.\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/chigwell/TaskFeasibilityAnalyzer/issues).\n\n## License\n\nThis project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/).\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python package to determine the feasibility of coding tasks using GPT-3.",
"version": "0.0.9",
"project_urls": {
"Homepage": "https://github.com/chigwell/TaskFeasibilityAnalyzer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "239fd32c15b71f89297e4e2dbd91b671388a51c26943fcc685cba622ad319244",
"md5": "6b229f1bf5525e8398a685ce45d09270",
"sha256": "23b99ddbe9d4c3e36877e84aa9a6a19b175d402f684932a193ec08247b50ad99"
},
"downloads": -1,
"filename": "TaskFeasibilityAnalyzer-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b229f1bf5525e8398a685ce45d09270",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5050,
"upload_time": "2024-01-06T20:56:26",
"upload_time_iso_8601": "2024-01-06T20:56:26.925539Z",
"url": "https://files.pythonhosted.org/packages/23/9f/d32c15b71f89297e4e2dbd91b671388a51c26943fcc685cba622ad319244/TaskFeasibilityAnalyzer-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "708bd711455c4a3e3b84bce38a74b11fcef17f519280c60e071500a8a588ccbf",
"md5": "29703bc1a570392da289cd5e49da2e1a",
"sha256": "45a9e723069f1020e31897f602991ae98ec5aa1f2d5964da9e4064fa20121994"
},
"downloads": -1,
"filename": "TaskFeasibilityAnalyzer-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "29703bc1a570392da289cd5e49da2e1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3634,
"upload_time": "2024-01-06T20:56:28",
"upload_time_iso_8601": "2024-01-06T20:56:28.567679Z",
"url": "https://files.pythonhosted.org/packages/70/8b/d711455c4a3e3b84bce38a74b11fcef17f519280c60e071500a8a588ccbf/TaskFeasibilityAnalyzer-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-06 20:56:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chigwell",
"github_project": "TaskFeasibilityAnalyzer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "taskfeasibilityanalyzer"
}
JSON
