# install package
## virtual environment
```
pip install mindmate
```
> It's not recommended to install in virtual environment _(except for testing)_ try it with default `pip`
## operating system level
```
sudo apt update
sudo apt install -y python3-pip
export PATH="$PATH:/home/$USER/.local/bin"
pip install mindmate
```
# usage
```
$ mindmate [ARGUMENT] [OPTIONS] [OPTIONS] [OPTIONS] --help
```
## examples
```
$ mindmate configure
$ mindmate directory prompting list
$ mindmate chat --platform openai \
--model text-davinci-003 \
--stream true \
--max-tokens 500 \
--prompt "Act as a professional developer, provide best file structure for fastAPI framework"
$ mindmate image create -p "mindmate written on the background in a garden and friends playing around"
```
# compatibility
__Not tested__ yet, but should be compatible with any Python >= 3.8
Raw data
{
"_id": null,
"home_page": "https://github.com/yalattas/mindmate",
"name": "mindmate",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cli,ai,nlp,ml,developers,productivity,openai,directory,manifest",
"author": "Yasser Alattas",
"author_email": "y.alattas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a4/0a/e319413b1b3edcf23cadeb23cf61f4eb4c1c9354480ff6addaef9ea84444/mindmate-0.1.7.tar.gz",
"platform": "any",
"description": "# install package\n\n## virtual environment\n```\npip install mindmate\n```\n> It's not recommended to install in virtual environment _(except for testing)_ try it with default `pip`\n\n## operating system level\n```\nsudo apt update\nsudo apt install -y python3-pip\nexport PATH=\"$PATH:/home/$USER/.local/bin\"\npip install mindmate\n```\n# usage\n```\n$ mindmate [ARGUMENT] [OPTIONS] [OPTIONS] [OPTIONS] --help\n```\n\n## examples\n```\n$ mindmate configure\n$ mindmate directory prompting list\n\n$ mindmate chat --platform openai \\\n --model text-davinci-003 \\\n --stream true \\\n --max-tokens 500 \\\n --prompt \"Act as a professional developer, provide best file structure for fastAPI framework\"\n\n$ mindmate image create -p \"mindmate written on the background in a garden and friends playing around\"\n```\n\n# compatibility\n\n__Not tested__ yet, but should be compatible with any Python >= 3.8\n\n\n",
"bugtrack_url": null,
"license": "LGPL-2.1 license",
"summary": "MindMate is a command-line tool that leverages the power of AI platforms to offer different use-cases to developers",
"version": "0.1.7",
"project_urls": {
"Download": "https://github.com/yalattas/mindmate",
"Homepage": "https://github.com/yalattas/mindmate"
},
"split_keywords": [
"cli",
"ai",
"nlp",
"ml",
"developers",
"productivity",
"openai",
"directory",
"manifest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8839b2eb8d308b10be9cf71009f8289b1a3a37031793c831656a6f6e15fe9e3d",
"md5": "9a83f79d4cdc654cb06c7992c7a76074",
"sha256": "a9a392e84002b0e91793a4bcf2e4e7307e241bb8d0427a2f1771ccd2b3fade5c"
},
"downloads": -1,
"filename": "mindmate-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a83f79d4cdc654cb06c7992c7a76074",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 25103,
"upload_time": "2023-07-02T03:10:06",
"upload_time_iso_8601": "2023-07-02T03:10:06.855602Z",
"url": "https://files.pythonhosted.org/packages/88/39/b2eb8d308b10be9cf71009f8289b1a3a37031793c831656a6f6e15fe9e3d/mindmate-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a40ae319413b1b3edcf23cadeb23cf61f4eb4c1c9354480ff6addaef9ea84444",
"md5": "3e6d37c665bf3fc6b2308c2ca11c6787",
"sha256": "275fc21b4bfc229e92bd9bffebced60f19e1b0599b9e7715e0e02a90d4b2cfbd"
},
"downloads": -1,
"filename": "mindmate-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "3e6d37c665bf3fc6b2308c2ca11c6787",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11456,
"upload_time": "2023-07-02T03:10:09",
"upload_time_iso_8601": "2023-07-02T03:10:09.566955Z",
"url": "https://files.pythonhosted.org/packages/a4/0a/e319413b1b3edcf23cadeb23cf61f4eb4c1c9354480ff6addaef9ea84444/mindmate-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-02 03:10:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yalattas",
"github_project": "mindmate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mindmate"
}