README.md 2.0 KB

PyCS

pipeline status coverage report made-with-python made-with-vuejs

PyCS is a python tool to use and fit machine learning models using any modern web browser.

Requirements

  • python 3.6 + pip
  • nodejs 14 + npm

Getting Started

CI Builds

Download the latest version and unzip it. Execute the following commands using a command prompt:

  • create and activate a virtual python environment

    python -m venv env
    source env/bin/activate
    
  • install python dependencies

    pip install numpy opencv-python Pillow scipy
    pip install eventlet flask python-socketio
    
  • start server

    python app.py
    

Docker

Docker is the preferred way to quickly start a PyCS instance without requiring any more software or libraries on your system.

  • build image with tag pycs

    docker build -t pycs .
    
  • start container

    docker run -p 5000:5000 pycs
    

Development

Use git to clone this repository or download the latest version as a zip file. Execute the following commands using a command prompt:

  • create and activate a virtual python environment

    python -m venv env
    source env/bin/activate
    
  • install python dependencies

    pip install numpy opencv-python Pillow scipy
    pip install eventlet flask python-socketio
    
  • start server

    python app.py
    
  • change directory to webui

    cd webui/
    
  • install vuejs and other dependencies

    npm install
    
  • start frontend

    npm run serve