{"id":19435496,"url":"https://github.com/cssnr/vultr-python","last_synced_at":"2025-04-24T21:30:34.790Z","repository":{"id":44909228,"uuid":"441314848","full_name":"cssnr/vultr-python","owner":"cssnr","description":"Python 3 wrapper for the Vultr API v2 Docs: https://cssnr.github.io/vultr-python","archived":false,"fork":false,"pushed_at":"2023-08-31T08:30:01.000Z","size":11,"stargazers_count":9,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-14T22:47:52.266Z","etag":null,"topics":["python","vultr"],"latest_commit_sha":null,"homepage":"https://www.vultr.com/?ref=6905748","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cssnr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-23T23:05:00.000Z","updated_at":"2024-09-06T03:10:19.000Z","dependencies_parsed_at":"2022-08-26T09:11:10.281Z","dependency_job_id":null,"html_url":"https://github.com/cssnr/vultr-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fvultr-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fvultr-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fvultr-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fvultr-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cssnr","download_url":"https://codeload.github.com/cssnr/vultr-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223703476,"owners_count":17188903,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","vultr"],"created_at":"2024-11-10T15:06:42.368Z","updated_at":"2024-11-10T15:06:42.959Z","avatar_url":"https://github.com/cssnr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Discord](https://img.shields.io/discord/899171661457293343?color=7289da\u0026label=discord\u0026logo=discord\u0026logoColor=white\u0026style=flat)](https://discord.gg/wXy6m2X8wY)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9b356c4327df41e395c81de1c717ce11)](https://app.codacy.com/gh/cssnr/vultr-python/dashboard)\n[![PyPI](https://img.shields.io/pypi/v/vultr-python)](https://pypi.org/project/vultr-python/)\n[![](https://repository-images.githubusercontent.com/441314848/513fb2f4-39cb-4bbc-8d47-a2cde9ccbd65)](https://www.vultr.com/?ref=6905748)\n# Vultr Python\n\nPython 3 wrapper for the Vultr API v2.\n\n*   Vultr: [https://www.vultr.com](https://www.vultr.com/?ref=6905748)\n*   Vultr API: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)\n*   Vultr Python Docs: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)\n\nThis is currently a WIP and not complete, but has some useful functions.\nFeel free to request additional functions and more on [Discord](https://discord.gg/wXy6m2X8wY).\n\n## Install\n\nFrom PyPi using pip:\n```text\npython -m pip install vultr-python\n```\n\nFrom Source using setuptools:\n```text\ngit clone https://github.com/cssnr/vultr-python.git\ncd vultr-python\npython setup.py install\n```\n\n## Usage\n\nYou will need to create an api key and whitelist your IP address.\nMost functions do not work without an API Key.\n\n*   [https://my.vultr.com/settings/#settingsapi](https://my.vultr.com/settings/#settingsapi)\n\nInitialize the class with your API Key or with the `VULTR_API_KEY` environment variable.\n```python\nfrom vultr import Vultr\n\nvultr = Vultr('VULTR_API_KEY')\n```\nList plans and get available regions for that plan\n```python\nplans = vultr.list_plans()\nplan = plans[0]  # 0 seems to be the basic 5 dollar plan\nregions = vultr.list_regions()\navailable = vultr.filter_regions(regions, plan['locations'])\n```\nGet the OS list and filter by name\n```python\nos_list = vultr.list_os()\nubuntu_lts = vultr.filter_os(os_list, 'Ubuntu 20.04 x64')\n```\nCreate a new ssh key from key string\n```python\nsshkey = vultr.create_key('key-name', 'ssh-rsa AAAA...')\n```\nCreate a new instance\n```python\nhostname = 'my-new-host'\ndata = {\n    'region': available[0]['id'],\n    'plan': plan['id'],\n    'os_id': ubuntu_lts['id'],\n    'sshkey_id': [sshkey['id']],\n    'hostname': hostname,\n    'label': hostname,\n}\ninstance = vultr.create_instance(**data)\n```\n\nView all functions at the Doc site: [https://cssnr.github.io/vultr-python](https://cssnr.github.io/vultr-python)\n\nView the full API documentation at Vultr: [https://www.vultr.com/api](https://www.vultr.com/api/?ref=6905748)\n\nIf you have more questions, concerns, or comments? Join our [Discord](https://discord.gg/wXy6m2X8wY) for more information...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssnr%2Fvultr-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcssnr%2Fvultr-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssnr%2Fvultr-python/lists"}