Skip to main content

Vectice Python library

Project description

Python library for Vectice project.

Developer’s Setup

1. Installation

It is recommended to install this library in a virtualenv using pip.

Supported Python Versions

Python >= 3.6

Mac/Linux

pip install virtualenv
virtualenv venv
source venv/bin/activate
venv/bin/pip install -e .[dev]

if using Zsh, add backslash (\) to escape square brackets:

venv/bin/pip install -e .\[dev\]

Windows

pip install virtualenv
virtualenv venv
venv\Scripts\activate
venv\Scripts\pip.exe install -e .[dev]

2. Start Backend Server

The backend server and database need to be running to receive requests from the Python library. See the backend repository for more details.

Make sure there exist at least one workspace and one project.

3. Prepare an ApiKey

Go to the GraphQL Playground: http://localhost:4000/graphql

Note that an authentication header is required to perform the following mutations.

Generate an ApiKey

mutation {
  generateApiKey(workspaceId: 1, apiKey: {name: "Key1"}) {key}
}

Be sure to save the key somewhere, for it will only show once.

Deploy the ApiKey

mutation {
  updateApiKey(workspaceId: 1, apiKeyId: 1, apiKey: {status: DEPLOYED}) {name, status}
}

4. Example Usage

Now, try to run some code in a Python console:

python -i
from vectice import Vectice
vectice = Vectice(project_token="xcvbn")
vectice.list_jobs()

5. Linting

Two linters are used cooperatively in this project, namely black and flake8. They will be run upon commits (pre-commit hooks) and pull requests (CI).

Commands to run them:

black .
flake8

It is recommended to run black first, then flake8.

6. Build

A build step is included in CI. To locally build:

pip install build
python -m build

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vectice-0.0.7.tar.gz (33.4 kB view details)

Uploaded Source

Built Distribution

vectice-0.0.7-py2.py3-none-any.whl (53.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file vectice-0.0.7.tar.gz.

File metadata

  • Download URL: vectice-0.0.7.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.8

File hashes

Hashes for vectice-0.0.7.tar.gz
Algorithm Hash digest
SHA256 996d36016f15fcee5a69f48f473d6816192bec0d387fda18471bfbdc3321a151
MD5 79e98dd1b764eb9bbd90a5d9ccf8f0f5
BLAKE2b-256 d9b737d5f737b09a1a268d2d5b674e63ace67e368a18d5548b6c3eaffa985cce

See more details on using hashes here.

File details

Details for the file vectice-0.0.7-py2.py3-none-any.whl.

File metadata

  • Download URL: vectice-0.0.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 53.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.8.8

File hashes

Hashes for vectice-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ef10a3827b2da31d7a0436755c77a2a51443cd8880c61c40acfed0db4ce96a3a
MD5 8cf15ee54b54aae4a9ad0eb75d50c146
BLAKE2b-256 dad71c5c42317763f47b809e0a436295ece9d807f8a75ad1e7868565efd66fda

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page