zaowr-polsl-kisiel 0.0.25

A simple Python package used by me and a friend at the university in the course 'Advanced Image, Video and Motion Analysis'

ZAOWR Package

This is a ZAOWR (Zaawansowana Analiza Obrazu, Wideo i Ruchu, eng. Advanced Image, Video, and Motion Analysis) Python package used by me and a friend at the university.

PyPI link to the package: MAIN PyPI, TEST PyPI.

Table of contents

1. Windows tutorial

2. RTFM - Use Cases for zaowr_polsl_kisiel and the importance of docstrings

3. Installing the package on Linux using pip

4. Removing the package on Linux using pip

5. Creating virtual environment and installing the package

6. Testing the installation

7. Automation: building and uploading with Makefile - DEV Tutorial

8. Building package - DEV Tutorial based on official DOCS

9. TODO for tracking issues / backlog / progress

10. Code requirements

11. Sources

Windows tutorial

The Windows tutorial can be found here

RTFM - Use Cases for zaowr_polsl_kisiel and the importance of docstrings

RTFM here

Installing the package on Linux using pip

1. PyPI MAIN
   
   

   python3 -m pip install --upgrade zaowr-polsl-kisiel
   



2. TestPyPI
   
   

   python3 -m pip install --index-url https://test.pypi.org/simple/ --upgrade zaowr-polsl-kisiel
   

Removing the package on Linux using pip

python3 -m pip uninstall zaowr-polsl-kisiel

Creating virtual environment and installing the package

[!NOTE]

Complete instructions on managing Python virtual environments

can be found here.

1. Create project directory and open it (directory where you will create your files and where the venv will be created). Below is an example of how to do it through Bash - you can also do it through file explorer
   
   

   testDir=/home/user/test
   

   mkdir -p $testDir
   

   cd $testDir
   

   
   
2. Create venv
   
   

   python -m venv ENV_NAME
   




[!NOTE]

ENV_NAME is the name of your venv, so you can change it however you like



3. Activate the venv (while in the project directory)
   
   

   source ENV_NAME/bin/activate
   

   or

   . ENV_NAME/bin/activate
   



4. Install the package from PyPI
   
   

   python3 -m pip install --upgrade zaowr-polsl-kisiel
   



5. (ADDITIONAL COMMAND) If you want to deactivate the currently active venv
   
   

   deactivate
   



6. (ADDITIONAL COMMAND) To reactivate the venv, navigate to the path where you created the venv and source it again (command shown above in section number 3)

Testing the installation

• Activate the venv (while in the project directory) - Skip this step if you are not using a virtual environment
  
  

  source ENV_NAME/bin/activate
  

  or

  . ENV_NAME/bin/activate
  



• Launch python
  
  

  python3
  



• Import the package
  
  

  from zaowr_polsl_kisiel import load_calibration
  



• Locate the file with calibration params in tests folder and download it (link below)
  
  

  ./tests/calibration_params/calibration_params.json



• Try reading the params from file
  
  

  # remember to provide appropriate path to the calibration params
  calibrationParams = load_calibration("../../tests/calibration_params/calibration_params.json")
  



• Display the MSE value to test if the load succeeded
  
  

  print(calibrationParams["mse"])
  

Code requirements

The code fulfills all the requirements necessary to pass the course. Detailed descriptions of the requirements for each lab are provided in the ./docs/code_requirements directory in the form of images (in Polish).

Sources

This package has been prepared following this tutorial.

The publishing to PyPI was created with this tutorial