Skip to content

Overview

  • The Everysk Library is a one-stop solution designed to help teams and partners streamline workflows and maximize productivity.

  • It is a Python library, built and distributed as a pip package, making it easy to integrate into any Python project.

  • Many projects at Everysk rely on multiple endpoints, engines, and utilities to automate workflows, handle entities such as portfolios, datastores, reports, and files, and perform complex calculations.

  • Adopting and maintaining each of these components individually can be both time-consuming and expensive.

  • To address this challenge, Everysk developed the Everysk Library: a unified Python library that bundles these capabilities into a single, convenient package.

  • By consolidating essential functionalities — ranging from portfolio creation to workflow automation — Everysk Lib greatly simplifies implementation and ongoing maintenance.

  • This all-in-one toolkit ensures everything needed to build powerful, scalable solutions across a variety of Everysk projects.


Installation

To install the Everysk library, you will need to use pip's install command:

pip install everysk-lib

Open a python terminal and run the following import:

import everysk

If the library has been installed correctly, this command should complete without any errors. If the library is not installed or there's a problem with the installation, Python will raise a ModuleNotFoundError


Structure

Below we have the main directories that you will be working with.

flowchart TB
    classDef orangeBorder fill:#1A1A1A,color:#E2E2E2,stroke:#FF9933,stroke-width:2px;

    EveryskLibrary(["Everysk Library"]):::orangeBorder
    SDKDir(["sdk"]):::orangeBorder
    CoreDir(["core"]):::orangeBorder
    ServerDir(["server"]):::orangeBorder
    ApiDir(["api"]):::orangeBorder

    EveryskLibrary --> CoreDir
    EveryskLibrary --> SDKDir
    EveryskLibrary --> ServerDir
    EveryskLibrary --> ApiDir


Core

The core module contains the main logic which will appear throughout the entire Everysk Library, the features can range from exceptions, making requests, using logs, serializing objects, and even working with threads.

SDK

The SDK module will contain all the entities and engines that you will be working with. This is the main building block of the Everysk SDK. The SDK module is divided into two sections: Entities, which are a set of classes that represent the main entities in the platform, such as Portfolio, Security, Datastore, File, Report, CustomIndex, and PrivateSecurity.

And the Engines, that are like core components that allow some piece of software to run. In Everysk, engines serve their different purposes. We have the expression engine, the cryptography engine, the compliance engine, and so on. All engines provide a set of methods for interacting with them.


Server

The Web Server module is designed to handle both HTML content and RESTful API requests.

It serves HTML content to clients, enabling the delivery of web pages and resources.

Additionally, it supports RESTful API endpoints, allowing clients to interact with the server using standard HTTP methods such as GET, POST, PUT, and DELETE.

This dual functionality makes the server versatile, catering to both traditional web applications and modern web services. The server ensures efficient handling of requests, providing a robust platform for web development and API integration.


API

Deprecated

This module is not recommended for new projects. We recommend using the Everysk SDK instead.

The current Everysk API module provides a set of methods for interacting with the Everysk REST API. If you need to work directly with our REST API through the Python wrapper, you can use this module. However, for most entities and use cases, we recommend using the Everysk SDK instead.