# FixedIT CLI installer
This package handles the installation of the FixedIT CLI tool. Please note that installation of the package will only be succesfull if a valid `FIXEDIT_TOKEN` is used, which you can acquire by contacting FixedIT Consulting to get access to the tool. Else, the `FixedIT CLI installer` package installation will just install the installation wrapper package and not the CLI tool itself.
## Installation configurations
Before installation you need to provide the `FIXEDIT_TOKEN`, which you can acquire by contacting FixedIT Consulting to get access to the tool. Before running the `pip install` command, you should export it as an env variable as:
```
export FIXEDIT_TOKEN=<YOUR_TOKEN>
```
Additionally, in case the `~/.fixedit` already exists and you want to overwrite it you should export the `FIXEDIT_TOKEN_OVERWRITE` environment variable.
Set it to 1 if you wish for the existing token to be overwritten by the environment variable `FIXEDIT_TOKEN`. This configuration is optional.
```
export FIXEDIT_TOKEN_OVERWRITE=1
```
In order to install FixedIT CLI using this installer package simply run the `pip` command below.
Optionally, for detailed logging you can add the verbose flag `-v` to the `pip` command.
```
pip install fixeditcli-installer
```
To verify that the FixedIT CLI tool is installed you can run the following command to get the version
(after you open up a new terminal):
```
fixeditcli-config version
```
More information on what commands are available and what can you do with FixedIT CLI can be found in the official documentation page [here](https://github.com/fixedit-ai/fappcli-readme).
## Something went wrong
In the case where the FixedIT CLI installer package installation is successfull, but you cannot access the FixedIT CLI commands you might have forgotten to export the `FIXEDIT_TOKEN` as an environment variable. To verify this is the case you can repeat the installation with the verbose flag `pip install -v fixeditcli-installer` to get more details on what went wrong during installation or export the variable and run the `pip` command again.
Raw data
{
"_id": null,
"home_page": "https://fixedit.ai",
"name": "fixeditcli-installer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "acap axis camera",
"author": "FixedIT Consulting AB",
"author_email": "info@fixedit.ai",
"download_url": "https://files.pythonhosted.org/packages/21/d6/03ecf565cd9f95b0aad086679ab032bfb1f297ef48fe254dd91595cde9f4/fixeditcli_installer-0.0.1.tar.gz",
"platform": null,
"description": "# FixedIT CLI installer\nThis package handles the installation of the FixedIT CLI tool. Please note that installation of the package will only be succesfull if a valid `FIXEDIT_TOKEN` is used, which you can acquire by contacting FixedIT Consulting to get access to the tool. Else, the `FixedIT CLI installer` package installation will just install the installation wrapper package and not the CLI tool itself.\n\n## Installation configurations\n\nBefore installation you need to provide the `FIXEDIT_TOKEN`, which you can acquire by contacting FixedIT Consulting to get access to the tool. Before running the `pip install` command, you should export it as an env variable as:\n```\nexport FIXEDIT_TOKEN=<YOUR_TOKEN>\n```\n\nAdditionally, in case the `~/.fixedit` already exists and you want to overwrite it you should export the `FIXEDIT_TOKEN_OVERWRITE` environment variable. \nSet it to 1 if you wish for the existing token to be overwritten by the environment variable `FIXEDIT_TOKEN`. This configuration is optional.\n```\nexport FIXEDIT_TOKEN_OVERWRITE=1\n```\n\nIn order to install FixedIT CLI using this installer package simply run the `pip` command below.\nOptionally, for detailed logging you can add the verbose flag `-v` to the `pip` command.\n```\npip install fixeditcli-installer\n```\n\nTo verify that the FixedIT CLI tool is installed you can run the following command to get the version\n(after you open up a new terminal):\n```\nfixeditcli-config version\n```\n\nMore information on what commands are available and what can you do with FixedIT CLI can be found in the official documentation page [here](https://github.com/fixedit-ai/fappcli-readme).\n\n## Something went wrong\nIn the case where the FixedIT CLI installer package installation is successfull, but you cannot access the FixedIT CLI commands you might have forgotten to export the `FIXEDIT_TOKEN` as an environment variable. To verify this is the case you can repeat the installation with the verbose flag `pip install -v fixeditcli-installer` to get more details on what went wrong during installation or export the variable and run the `pip` command again.",
"bugtrack_url": null,
"license": "proprietary",
"summary": "Installer for FixedIT CLI tool",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://fixedit.ai"
},
"split_keywords": [
"acap",
"axis",
"camera"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21d603ecf565cd9f95b0aad086679ab032bfb1f297ef48fe254dd91595cde9f4",
"md5": "948eb1b658a15369b0efd78af3a5c79f",
"sha256": "afda9f537c1d2c8a450d97268438c2287f39c9115e0dd355b170ddc0524dadc7"
},
"downloads": -1,
"filename": "fixeditcli_installer-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "948eb1b658a15369b0efd78af3a5c79f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4396,
"upload_time": "2024-08-13T09:12:46",
"upload_time_iso_8601": "2024-08-13T09:12:46.317652Z",
"url": "https://files.pythonhosted.org/packages/21/d6/03ecf565cd9f95b0aad086679ab032bfb1f297ef48fe254dd91595cde9f4/fixeditcli_installer-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-13 09:12:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fixeditcli-installer"
}
JSON