vectice 0.18.1

Vectice Python library

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