| Name | beegen JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | https://github.com/pavanad/beegen |
| Summary | BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI. |
| upload_time | 2024-10-21 21:08:45 |
| maintainer | None |
| docs_url | None |
| author | Adilson Pavan |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="docs/images/beegen.png" alt="BeeGen">
</p>
<p align="center">
<em>BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI.</em>
</p>
<p align="center">
<a href="https://pypi.org/project/beegen/"><img alt="PyPI Latest Release" src="https://img.shields.io/pypi/v/beegen.svg"></a>
<a href="https://pypi.org/project/beegen/"><img alt="PyPI Downloads" src="https://img.shields.io/pypi/dm/beegen.svg?label=PyPI%20downloads"></a>
<a href="https://github.com/psf/black"><img alt="Code Style Black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="https://pycqa.github.io/isort/"><img alt="Imports Isort" src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336"></a>
<a href="https://github.com/PyCQA/bandit"><img alt="Security Bandit" src="https://img.shields.io/badge/security-bandit-yellow.svg"></a>
</p>
## BeeGen
With Beegen, you can streamline your development process, improve code quality, and automate various aspects of project creation and management.
## Features
- **Mock APIs:** Quickly create and run mock API servers.
- **Sensitive Data Anonymization:** Use generative AI to mask identifiable information and ensure privacy.
- **Vector Store Generation:** Create a local vector store using FAISS for projects that require semantic search.
- **README Generator:** Automatically generate a detailed README file for your projects.
- **Translation:** Quickly translate text between different languages.
- **Code Snippets:** Add, list, remove, and use code snippets directly from the command line.
- **AI Chat Interface:** Interact with language models in a terminal-based chat.
## Installation
You can install BeeGen in three ways:
[PyPI](https://pypi.org/project/beegen/)
```bash
pip install beegen
```
Directly from the repository using [poetry](https://python-poetry.org/)
```bash
poetry install
```
Using pipx (recommended):
```bash
pipx install beegen
```
Why `pipx`?
`pipx` installs BeeGen in an isolated environment, avoiding conflicts with other Python packages on your system. This is ideal for command-line tools.
## Usage
Here are a few examples of how you can use BeeGen for daily tasks:
### Configure
Configure the LLM and access keys for usage.
```bash
beegen configure
```
Supported models include:
- **OpenAI:** Requires a valid OpenAI API key.
- **Ollama:** You need to install the Ollama CLI tool locally and download the desired model for it to work. More details can be found at [Ollama's official site](https://ollama.com/).
- **Gemini:** You can use the free model with a personal key. For more information, visit [Gemini's official site](https://aistudio.google.com/).
### Create a Mock API
Generate a configuration file for a mock API:
```bash
beegen mock create
```
**Mockefile (template)**
```yaml
authentication:
key: 20s7ILRwS9eMU8sXQ1sT9WaxFQTJwK5usCz3P_Ium6E
name: X-API-Key
type: api_key
description: BeeGen mockfile API example
endpoints:
- access: public
method: GET
path: /users
response:
body:
- email: john.doe@example.com
id: 1
name: John Doe
- email: jane.doe@example.com
id: 2
name: Jane Doe
status: 200
- access: protected
method: POST
path: /user
request:
- description: The user ID
name: id
type: int
- description: The user name
name: name
type: str
- description: The user email
name: email
```
Run the mock API server:
```bash
beegen mock run
```
### Anonymize Sensitive Data
Use the following command to anonymize sensitive data with generative AI to ensure privacy by masking identifiable information:
```bash
beegen smart anonymize-data "<your text>"
```
Anonymize sensitive data in files:
```bash
beegen smart anonymize-data --file data.txt
```
### Create a Vector Store
Build a local vector store from specific files or directories:
```bash
beegen smart create-vectorstore <your path>
```
### Generate a README
Automatically generate a detailed README file for your project:
```bash
beegen smart readme <your path>
```
### Generate a Regex
Generate a regular expression based on the provided value:
```bash
beegen smart regex "email@email.com" --language python
```
### Full List of Commands
To view the complete list of available commands, run:
```bash
beegen list
```
## Contributing
Contributions to BeeGen are welcome! If you find a bug, have a feature request, or want to improve the code, please submit a pull request.
## License
BeeGen is licensed under the MIT License. See the [LICENSE](/LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/pavanad/beegen",
"name": "beegen",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Adilson Pavan",
"author_email": "adilson.pavan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/da/e6/e373bbd9c83552d94388add3873b11cd503214cce1d94ee54b1acf241ac4/beegen-0.1.5.tar.gz",
"platform": null,
"description": "<p align=\"center\"> \n <img src=\"docs/images/beegen.png\" alt=\"BeeGen\"> \n</p>\n<p align=\"center\">\n <em>BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI.</em>\n</p>\n<p align=\"center\"> \n <a href=\"https://pypi.org/project/beegen/\"><img alt=\"PyPI Latest Release\" src=\"https://img.shields.io/pypi/v/beegen.svg\"></a>\n <a href=\"https://pypi.org/project/beegen/\"><img alt=\"PyPI Downloads\" src=\"https://img.shields.io/pypi/dm/beegen.svg?label=PyPI%20downloads\"></a>\n <a href=\"https://github.com/psf/black\"><img alt=\"Code Style Black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n <a href=\"https://pycqa.github.io/isort/\"><img alt=\"Imports Isort\" src=\"https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\"></a>\n <a href=\"https://github.com/PyCQA/bandit\"><img alt=\"Security Bandit\" src=\"https://img.shields.io/badge/security-bandit-yellow.svg\"></a> \n</p>\n\n## BeeGen\n\nWith Beegen, you can streamline your development process, improve code quality, and automate various aspects of project creation and management.\n\n## Features\n\n- **Mock APIs:** Quickly create and run mock API servers.\n- **Sensitive Data Anonymization:** Use generative AI to mask identifiable information and ensure privacy.\n- **Vector Store Generation:** Create a local vector store using FAISS for projects that require semantic search.\n- **README Generator:** Automatically generate a detailed README file for your projects.\n- **Translation:** Quickly translate text between different languages.\n- **Code Snippets:** Add, list, remove, and use code snippets directly from the command line.\n- **AI Chat Interface:** Interact with language models in a terminal-based chat.\n\n## Installation\n\nYou can install BeeGen in three ways:\n\n[PyPI](https://pypi.org/project/beegen/)\n\n```bash\npip install beegen\n```\n\nDirectly from the repository using [poetry](https://python-poetry.org/)\n\n```bash\npoetry install\n```\n\nUsing pipx (recommended):\n\n```bash\npipx install beegen\n```\n\nWhy `pipx`?\n\n`pipx` installs BeeGen in an isolated environment, avoiding conflicts with other Python packages on your system. This is ideal for command-line tools.\n\n## Usage\n\nHere are a few examples of how you can use BeeGen for daily tasks:\n\n### Configure\n\nConfigure the LLM and access keys for usage.\n\n```bash\nbeegen configure\n```\n\n\n\nSupported models include:\n- **OpenAI:** Requires a valid OpenAI API key.\n- **Ollama:** You need to install the Ollama CLI tool locally and download the desired model for it to work. More details can be found at [Ollama's official site](https://ollama.com/).\n- **Gemini:** You can use the free model with a personal key. For more information, visit [Gemini's official site](https://aistudio.google.com/).\n\n### Create a Mock API\n\nGenerate a configuration file for a mock API:\n\n```bash\nbeegen mock create\n```\n\n**Mockefile (template)**\n\n```yaml\nauthentication:\n key: 20s7ILRwS9eMU8sXQ1sT9WaxFQTJwK5usCz3P_Ium6E\n name: X-API-Key\n type: api_key\ndescription: BeeGen mockfile API example\nendpoints:\n- access: public\n method: GET\n path: /users\n response:\n body:\n - email: john.doe@example.com\n id: 1\n name: John Doe\n - email: jane.doe@example.com\n id: 2\n name: Jane Doe\n status: 200\n- access: protected\n method: POST\n path: /user\n request:\n - description: The user ID\n name: id\n type: int\n - description: The user name\n name: name\n type: str\n - description: The user email\n name: email\n```\n\nRun the mock API server:\n\n```bash\nbeegen mock run\n```\n\n### Anonymize Sensitive Data\n\nUse the following command to anonymize sensitive data with generative AI to ensure privacy by masking identifiable information:\n\n```bash\nbeegen smart anonymize-data \"<your text>\"\n```\n\n\n\nAnonymize sensitive data in files:\n\n```bash\nbeegen smart anonymize-data --file data.txt\n```\n\n### Create a Vector Store\n\nBuild a local vector store from specific files or directories:\n\n```bash\nbeegen smart create-vectorstore <your path>\n```\n\n\n\n### Generate a README\n\nAutomatically generate a detailed README file for your project:\n\n```bash\nbeegen smart readme <your path>\n```\n\n\n\n### Generate a Regex\n\nGenerate a regular expression based on the provided value:\n\n```bash\nbeegen smart regex \"email@email.com\" --language python\n```\n\n\n\n### Full List of Commands\n\nTo view the complete list of available commands, run:\n\n```bash\nbeegen list\n```\n\n## Contributing\n\nContributions to BeeGen are welcome! If you find a bug, have a feature request, or want to improve the code, please submit a pull request.\n\n## License\n\nBeeGen is licensed under the MIT License. See the [LICENSE](/LICENSE) file for more information.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI.",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/pavanad/beegen",
"Repository": "https://github.com/pavanad/beegen"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71b908af5095b0713075847795cf667e2ef84a04f69c654a64e1970149c07302",
"md5": "fbb700042152d298dc0294b02ddcd9f5",
"sha256": "4287eaddec6d62f72ff5f4a8c7e6e647885394d45d2953157c30de42e6d3ee13"
},
"downloads": -1,
"filename": "beegen-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fbb700042152d298dc0294b02ddcd9f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 69653,
"upload_time": "2024-10-21T21:08:43",
"upload_time_iso_8601": "2024-10-21T21:08:43.633274Z",
"url": "https://files.pythonhosted.org/packages/71/b9/08af5095b0713075847795cf667e2ef84a04f69c654a64e1970149c07302/beegen-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dae6e373bbd9c83552d94388add3873b11cd503214cce1d94ee54b1acf241ac4",
"md5": "3c5492ff6197a4dae16ad5d3ac638acd",
"sha256": "4c415cfc1c0d349db432d69774973fa2676ca49e1c9cdb239edb96fbbf4f6017"
},
"downloads": -1,
"filename": "beegen-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "3c5492ff6197a4dae16ad5d3ac638acd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 60824,
"upload_time": "2024-10-21T21:08:45",
"upload_time_iso_8601": "2024-10-21T21:08:45.573879Z",
"url": "https://files.pythonhosted.org/packages/da/e6/e373bbd9c83552d94388add3873b11cd503214cce1d94ee54b1acf241ac4/beegen-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 21:08:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pavanad",
"github_project": "beegen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "beegen"
}
