Skip to main content

Comring, the PTI ERP companion tool

Project description


Comring is a companion tool for Paragon ERP.

Building from Source

python3 sdist bdist_wheel

Optionally, release to pypi:

python3 -m twine upload dist/*


Install using pip

pip install comring

Odoo Environments Configuration

The system will read Odoo servers (environments) configuration from $HOME/.config/odoopti.yaml file:

        name: Odoo Live
        database: paragon
        kind: live
        user: toolbox
        password: secretpass

        name: Local Testing
        url: http://localhost:8069
        database: test
        kind: live
        user: admin
        password: 1


Description for each environment configuration keys:

  1. name: Name or label
  2. url: Server url
  3. database: Database to be used
  4. kind: Implementation. Valid values are: live, spinoff, nbm
  5. user: The user to be used when communicating with the server
  6. password: Password for the user

Web App

Development Mode with Flask Built-in Server

Environment Variables

The web app uses flask as engine, these variables can be set to configure the app. You can refer to flask docs for a complete reference. This project also uses python-dotenv so you can create .env file to set env vars more easily. The three most important variables are:


Running with Self-Signed SSL certificate

To generate a self-signed SSL certificate:

openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365

Add this to .env:


Running Development Server

To run web app:

flask run

Production Mode with CherryPI's WSGI Server

Run the webapp for the first time:

python3 -m comring.webapp [-a bind_address] [-p bind_port]

Wait for about 3 seconds, then press CTRL+C to stop the application. Next you will need to generate a secret key for this production server:

python -c 'import os; print("SECRET_KEY =", os.urandom(16))' > venv/var/comring.webapp-instance/

Then run the application again. The cookie encryption will now use the generated secret key above.

Performance Testing

In this example we'll use apache-util's ab testing tool to stress test the web application.


ab available from apache2-utils package

sudo apt-get install apache2-utils

Run application

Run in development mode or production mode. You may also test remotely deployed application.

Get a Sesssion Cookie

Open the application in browser, then login. We will reuse the cookie used by the browser in ab:

  1. Open developer tool
  2. In the 'Application' or 'Storage' menu, search for Cookies
  3. Copy the session cookie value

Run ab

To run 160 requests split into 80 concurrent users:

ab -n 160 -c 80 -C session=<cookie valued copied from browser> -p benchmark/ -T 'application/x-www-form-urlencoded' http://localhost:5500/invoice/by_brand

Alternative: siege

Create .siegerc file to set server address and login credentials:

SERVER_URL = http://localhost:5555
login-url = ${SERVER_URL}/auth/login POST environment=live&username=myuser&password=mypassword

Adjust url and parameters to suit your need, then run siege:

siege -f benchmark/siege-local-small.txt -b -c 80 -r 2

Read siege manual for more information on how to use it.

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

comring-0.2.3.tar.gz (5.6 MB view hashes)

Uploaded source

Built Distribution

comring-0.2.3-py3-none-any.whl (6.2 MB view hashes)

Uploaded py3

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