Everysk Library
| Testing |   |
| Package |  |
The Everysk Library is a one-stop solution designed to help our teams and partners streamline workflows and maximize productivity.
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 you have everything you need to build powerful, scalable solutions across a variety of Everysk projects.
Table of Contents
Module Structure
Below we have the main directories that you will be working with.
flowchart TB
EveryskLibrary(["Everysk Library"])
SDKDir(["sdk"])
CoreDir(["core"])
ServerDir(["server"])
ApiDir(["api"])
EveryskLibrary --> SDKDir
EveryskLibrary --> CoreDir
EveryskLibrary --> ServerDir
EveryskLibrary --> ApiDir
Installation
To install the Everysk library, you will need to use pip's install command:
pip install everysk-lib
Verifying the Installation
After installing the library, it's a good practice to verify if the installation was successful. Here is how to achieve this:
1. Open a terminal
2. Start the Python interpreter by typing python and pressing Enter
3. In the Python interpreter, type the following command then press Enter:
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
Documentation
The main documentation of the Everysk Library can be founded here: Everysk Library Documentation
Running Tests
This section provides instructions on how to run tests for the project. There are two scenarios, the first one is running tests in a development environment and the second one is running tests after the library has been installed from PyPI.
Running Tests in Development Environment
In a development environment you can use the provided shell script to run the tests. The script sets up the necessary environment and then run the tests. To execute the tests, open a bash terminal and run the following command.
./run.sh tests
Running Tests After the Library is Installed
After the library has been installed in your project from PyPI, you can start running tests using Python's built-in unittest module. To run tests use the following command:
python3 -m unittest everysk.core.tests
The command uses Python's unittest module as mentioned above as a script, which then runs the test in the everysk.core.tests package.
Running Tests with coverage
Code coverage us a way of measuring how many lines of code are executed while the automated tests are running.
To run tests along with a coverage report, you can use the provided shell script. The script will not only run the tests but also generate a coverage report that shows the percentage of code that was executed during the tests.
This is useful to identify sections of your code that are not being tested and may need additional tests.
1. Open a terminal in your Visual Studio Code environment.
2. Run the following command.
./run.sh coverage
This command executes the run.sh script with the coverage argument. The report will be displayed in the terminal after the script completed the tests.
Remember: a high coverage percentage is generally good, but 100% coverage does not ensures that your code is free from bugs or any other problem that might occur in your code. The full coverage just means that all the lines in your code were executed during the tests.
Contributing
Contributions are always welcome and greatly appreciated!
Go to the repository link and click on the Fork button to create your own copy of the everysk library.
Then clone the project in your own local machine by running the command below or using the GitHub Desktop.
git clone https://github.com/<your-username>/everysk-lib.git everysk-yourusername
This section creates a directory called everysk-yourusername to center all your code.
After that you can change the directory by:
cd everysk-yourusername
Create the upstream repository which will refer to the main repository that you just forked.
git remote add upstream https://github.com/Everysk/everysk-lib.git
Now run the following commands to make sure that your clone is up-to-date with main everysk repository
git checkout main
git pull upstream main
Shortly after, create a new branch to add your code
git checkout -b brand-new-feature
The command above will automatically switch to this newly created branch. At this moment your are able to make your modifications to the code and commit locally as you progress.
After all the code changes, you can submit your contribution by pushing the changes to your fork on GitHub:
git push origin brand-new-feature
The command above ensures that all the modifications that you've made are up-to-date with your current branch.
At the end of this process you will need to make a Pull Request to the main branch.
To achieve this, go to the GitHub page of the project and click on the Pull requests tab, then click on New pull request button.
This will open a new section used to compare branches, now choose your branch for merging into the main branch and hit the Create pull request button.
License
(C) Copyright 2025 EVERYSK TECHNOLOGIES
This is an unpublished work containing confidential and proprietary information of EVERYSK TECHNOLOGIES. Disclosure, use, or reproduction without authorization of EVERYSK TECHNOLOGIES is prohibited.
Date: Jan 2025
Contact: contact@everysk.com
URL: https://everysk.com/
1 maintainer
Metadata
1 maintainer
Release files for everysk-lib 1.13.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| everysk_lib-1.13.2.tar.gz | 265.2 kB | Details |
Built distributions (wheels)
Total release size: 19.2 MB
Release files / everysk_lib-1.13.2.tar.gz
| Download URL | everysk_lib-1.13.2.tar.gz |
|---|---|
| Size | 265.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1e447654e4ee4c9411f7611b12d0dff027b88c567d238c3be5d590a15cca3a2b
|
|
BLAKE2b-256 checksum How to use checksums |
c39ebf8637a6682e28ce5295be9e8620e4c165c2d7ce177232602ac116a99230
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp312-cp312-win_amd64.whl
| Download URL | everysk_lib-1.13.2-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 2.0 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
3df435c7b79ab59d59d9dd53dc995f3f33824408b3faddb999d2da8a0dd73d0e
|
|
BLAKE2b-256 checksum How to use checksums |
750af44f56255d99092cf25b539d9e07c851813ff36b1f476efc723483252dad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp312-cp312-musllinux_1_2_x86_64.whl
| Download URL | everysk_lib-1.13.2-cp312-cp312-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 3.0 MB |
| Tags | CPython 3.12 Linux musl 1.2+ x86-64 |
|
SHA-256 checksum How to use checksums |
735041a34439c229d5b818366eb5324b4f628e018293f571b48bc9010c05e3b9
|
|
BLAKE2b-256 checksum How to use checksums |
6651bf9d2a51a376f37a6875dc29591c1208b0a6a55149f8e23387423b7710e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
| Download URL | everysk_lib-1.13.2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 2.9 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
a8b42f81d2df61d77101d76347db2a59ef3d72e35f9b0fe38794e133677073e5
|
|
BLAKE2b-256 checksum How to use checksums |
b819692a65365ef42e5558b87d08366702ef3caec68288d9212d0450f63e62e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | everysk_lib-1.13.2-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.1 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
4577c0e11fce5ffc5fde426a60ecd2b6c8b1d6ce68887856c06cb4c58d3eb429
|
|
BLAKE2b-256 checksum How to use checksums |
1a7a4263a6911055fcc4f05d7d0b366cc2c4055e4314c0d9025f6213f3e5df49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp311-cp311-win_amd64.whl
| Download URL | everysk_lib-1.13.2-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 2.0 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e786a3e08a0779beed006f97afdd739f302012cb6312533817987d4af2ebe9e9
|
|
BLAKE2b-256 checksum How to use checksums |
6bdf6c2ef2d0ccc5778b671b06de551a93feb6c7d8c1a0a527122ac86eab758a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp311-cp311-musllinux_1_2_x86_64.whl
| Download URL | everysk_lib-1.13.2-cp311-cp311-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 2.5 MB |
| Tags | CPython 3.11 Linux musl 1.2+ x86-64 |
|
SHA-256 checksum How to use checksums |
f0b7ada823e7076ba87709a6e19809e4a1773cd5f7a4172c9d64423196cd0d2c
|
|
BLAKE2b-256 checksum How to use checksums |
73d6a8b2100932acfc640983fc830eae77eb9a75510c3874422d33f9b464380d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl
| Download URL | everysk_lib-1.13.2-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 2.5 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
4942636afaab6eb7806e1e63fc3445d3e93d030ed66579b04de5e3d3984aed29
|
|
BLAKE2b-256 checksum How to use checksums |
69b917fffb25626b8b47182a24f66688223c5551b7f6399f1292406347d03649
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / everysk_lib-1.13.2-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | everysk_lib-1.13.2-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.0 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
7449443dc1d0939e191821631bf758e2837003b55c5082268ca31f97028eb84d
|
|
BLAKE2b-256 checksum How to use checksums |
cffd6ecd253404071b533fa38f768e6715ae57ca9f41886b6d1711e48e1a4d6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
