# Vertopal-CLI
**Vertopal-CLI** is a small yet powerful utility that allows you to convert
digital files into various formats using the
[Vertopal public API](https://www.vertopal.com/en/developer/api).
You can use Vertopal-CLI by either *terminal commands* or
*importing as a Python package*.
## Installing Vertopal-CLI
Vertopal-CLI is available on [PyPI](https://pypi.org/project/vertopal/):
```bash
python -m pip install vertopal
```
You can also download the most recent version of Vertopal-CLI binaries for
**macOS**, **Windows**, and **Linux** from the
[releases page](https://github.com/vertopal/vertopal-cli/releases/latest) or
the [product page](https://www.vertopal.com/en/product/cli).
### Installer
An automatic installer is available for each different platform. It will run an
install script that downloads and copy Vertopal-CLI binaries to the correct
location.
Using macOS Terminal:
```bash
curl https://run.vertopal.com/cli/macos | bash
```
On Windows using PowerShell:
```bash
(curl https://run.vertopal.com/cli/windows).Content | iex
```
If you are getting any **UnauthorizedAccess** error, then start Windows
PowerShell with the "Run as administrator" option and run
`Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine`.
Now re-run the above installation command. To change the
[*Execution Policies*](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies)
to its default, you can run
`Set-ExecutionPolicy -ExecutionPolicy Default -Scope LocalMachine`.
Using Linux Terminal:
```bash
curl https://run.vertopal.com/cli/linux | bash
```
## Using Vertopal-CLI
To use Vertopal-CLI you need to [obtain an App-ID and a Security Token](http://www.vertopal.com/en/account/api/app/new).
Converting files using terminal commands are very simple:
```bash
vertopal convert document.ipynb --to pdf
```
To view full command-line help, execute `vertopal --help`
and `vertopal convert --help` in terminal.
### Setting App ID and Security Token
Before executing `vertopal convert` commands in terminal, you need to set
your obtained App-ID and Security Token in global configuration file:
```bash
vertopal config --app "your-app-id" --token "your-security-token"
```
### Importing as Python package
Importing vertopal as a Python package makes it easy
to implement file conversions in your projects.
The following code illustrates
[GIF to APNG](https://www.vertopal.com/en/convert/gif-to-apng) conversion using
the Vertopal Python package.
```python
import vertopal
converter = vertopal.Converter(
"MickeyMouse.gif",
app="your-app-id",
token="your-security-token",
)
converter.convert("apng")
converter.wait()
if converter.is_converted():
converter.download()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/vertopal/vertopal-cli",
"name": "vertopal",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.7",
"maintainer_email": "",
"keywords": "convert,file,vertopal,api,converter",
"author": "",
"author_email": "Vertopal <contact@vertopal.com>",
"download_url": "https://files.pythonhosted.org/packages/c2/02/21866d5130809a4895090c5c60cff49044ec0dbfc09c580cecda049e93dc/vertopal-1.1.0.tar.gz",
"platform": null,
"description": "# Vertopal-CLI\n\n**Vertopal-CLI** is a small yet powerful utility that allows you to convert\ndigital files into various formats using the\n[Vertopal public API](https://www.vertopal.com/en/developer/api).\n\nYou can use Vertopal-CLI by either *terminal commands* or\n*importing as a Python package*.\n\n## Installing Vertopal-CLI\n\nVertopal-CLI is available on [PyPI](https://pypi.org/project/vertopal/):\n\n```bash\npython -m pip install vertopal\n```\n\nYou can also download the most recent version of Vertopal-CLI binaries for\n**macOS**, **Windows**, and **Linux** from the\n[releases page](https://github.com/vertopal/vertopal-cli/releases/latest) or\nthe [product page](https://www.vertopal.com/en/product/cli).\n\n### Installer\n\nAn automatic installer is available for each different platform. It will run an\ninstall script that downloads and copy Vertopal-CLI binaries to the correct\nlocation.\n\nUsing macOS Terminal:\n\n```bash\ncurl https://run.vertopal.com/cli/macos | bash\n```\n\nOn Windows using PowerShell:\n\n```bash\n(curl https://run.vertopal.com/cli/windows).Content | iex\n```\n\nIf you are getting any **UnauthorizedAccess** error, then start Windows\nPowerShell with the \"Run as administrator\" option and run\n`Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine`.\nNow re-run the above installation command. To change the\n[*Execution Policies*](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies)\nto its default, you can run\n`Set-ExecutionPolicy -ExecutionPolicy Default -Scope LocalMachine`.\n\nUsing Linux Terminal:\n\n```bash\ncurl https://run.vertopal.com/cli/linux | bash\n```\n\n## Using Vertopal-CLI\n\nTo use Vertopal-CLI you need to [obtain an App-ID and a Security Token](http://www.vertopal.com/en/account/api/app/new).\n\nConverting files using terminal commands are very simple:\n\n```bash\nvertopal convert document.ipynb --to pdf\n```\n\nTo view full command-line help, execute `vertopal --help`\nand `vertopal convert --help` in terminal.\n\n### Setting App ID and Security Token\n\nBefore executing `vertopal convert` commands in terminal, you need to set\nyour obtained App-ID and Security Token in global configuration file:\n\n```bash\nvertopal config --app \"your-app-id\" --token \"your-security-token\"\n```\n\n### Importing as Python package\n\nImporting vertopal as a Python package makes it easy\nto implement file conversions in your projects.\n\nThe following code illustrates\n[GIF to APNG](https://www.vertopal.com/en/convert/gif-to-apng) conversion using\nthe Vertopal Python package.\n\n```python\nimport vertopal\n\nconverter = vertopal.Converter(\n \"MickeyMouse.gif\",\n app=\"your-app-id\",\n token=\"your-security-token\",\n)\nconverter.convert(\"apng\")\nconverter.wait()\nif converter.is_converted():\n converter.download()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Convert your files in terminal using Vertopal API",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/vertopal/vertopal-cli/issues",
"Funding": "https://www.vertopal.com/en/donate",
"Homepage": "https://www.vertopal.com",
"Source": "https://github.com/vertopal/vertopal-cli"
},
"split_keywords": [
"convert",
"file",
"vertopal",
"api",
"converter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d144d06eb6053e985a270724c469d878b0e459157159e198728f29a8cc7efff2",
"md5": "5972762b2c315fd04077a889bf1ac8c5",
"sha256": "8fb119ccd95a55b5ce70d27889c12af34753122faf481b5168383b8a67a8e9cc"
},
"downloads": -1,
"filename": "vertopal-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5972762b2c315fd04077a889bf1ac8c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.7",
"size": 24521,
"upload_time": "2024-01-07T18:56:43",
"upload_time_iso_8601": "2024-01-07T18:56:43.320135Z",
"url": "https://files.pythonhosted.org/packages/d1/44/d06eb6053e985a270724c469d878b0e459157159e198728f29a8cc7efff2/vertopal-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c20221866d5130809a4895090c5c60cff49044ec0dbfc09c580cecda049e93dc",
"md5": "8d0ff211335830cc484e764563d7a5e1",
"sha256": "6f715718d25fd51d54aeff085091cc9d4911ca77eafcd0a58e44c7879de27e92"
},
"downloads": -1,
"filename": "vertopal-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8d0ff211335830cc484e764563d7a5e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.7",
"size": 21477,
"upload_time": "2024-01-07T18:56:44",
"upload_time_iso_8601": "2024-01-07T18:56:44.938406Z",
"url": "https://files.pythonhosted.org/packages/c2/02/21866d5130809a4895090c5c60cff49044ec0dbfc09c580cecda049e93dc/vertopal-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-07 18:56:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vertopal",
"github_project": "vertopal-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vertopal"
}
JSON
