Skip to main content

Package to get started optimizing

Project description

Paretos package

This is the paretos package for easy integration of socrates optimization within customer environments. The package also enables to get the results of socrates api in an easy and understandable way.

Installation

The installation of the package is simply done via. pip

pip install paretos

Usage

In general the complete documentation for usage and classes can be found here. In this readme only brief overview of the most important points to get started is given.

Development

This section is aimed towards developers of the paretos library.

Getting Started

You will find some executable examples in the /examples folder.

See examples/getting-started.md for the necessary steps to run those scripts.

Linting

  • isort .
  • black .

Unit Testing

  • python -m unittest discover test/unittest
  • coverage run --source paretos -m unittest discover test/unittest
  • coverage html

Setting up Testbench for Frontend

To setup some test projects in certain states for frontend tests you can use the script in test/frontend_testbench To call it you have to set the following environment variables:

  • SOCRATES_URL
  • PARETOS_USERNAME
  • PARETOS_PASSWORD

Then call the script: python test/frontend_testbench/init_testbench.py

The script will use the socrates-api to create projects and run optimizations to create some edge-cases for frontend tests.

Dependencies

  • requires connection to Socrates API 1.2.0 or newer

Project details


Download files

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

Source Distribution

paretos-4.1.0.tar.gz (27.7 kB view hashes)

Uploaded source

Built Distribution

paretos-4.1.0-py3-none-any.whl (49.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page