Skip to content

docs-developmentguide-python.md

Latest commit

 

History

History
92 lines (65 loc) · 3.4 KB

docs-developmentguide-python.md

File metadata and controls

92 lines (65 loc) · 3.4 KB

developmentguide-python

Contact: numbworks@gmail.com

Revision History

Date Author Description
2026-05-10 numbworks Created.
2026-05-10 numbworks Last update.

Introduction

This development guide collects all the information to get started with a nw project as a developer.

Getting Started

To run this application on Windows and Linux:

  1. Download and install Visual Studio Code;

  2. Download and install Docker;

  3. Download and install Git;

  4. Open your terminal application of choice and type the following commands:

    mkdir {project_name}
cd {project_name}
git clone https://github.com/numbworks/{project_name}.git

  5. Launch Visual Studio Code and install the following extensions:

  6. In order for the Jupyter Notebook to automatically detect changes in the underlying library, click on File > Preferences > Settings and change the following setting as below:

    "jupyter.runStartupCommands": [
    "%load_ext autoreload", "%autoreload 2"
]

  7. In order for Pylance to perform type checking, set the python.analysis.typeCheckingMode setting to basic;

  8. Click on File > Open folder > {project_name};

  9. Click on View > Command Palette and type:

    > Dev Container: Reopen in Container

  10. Wait some minutes for the container defined in the .devcointainer folder to be built;

  11. Done!

Unit Tests

To run the unit tests in Visual Studio Code (while still connected to the Dev Container):

  1. click on the Testing icon on the sidebar, right-click on tests > Run Test;
  2. select the Python interpreter inside the Dev Container (if asked);
  3. Done!

To calculate the total unit test coverage in Visual Studio Code (while still connected to the Dev Container):

  1. Terminal > New Terminal;

  2. Run the following commands to get the total unit test coverage:

    cd tests
coverage run -m unittest {project_name}tests.py
coverage report --omit={project_name}tests.py

  3. Run the following commands to get the unit test coverage per class:

    cd tests
coverage run -m unittest {project_name}tests.py
coverage html --omit={project_name}tests.py && sed -n '/<table class="index" data-sortable>/,/<\/table>/p' htmlcov/class_index.html | pandoc --from html --to plain && sleep 3 && rm -rf htmlcov

  4. Done!

Markdown Toolset

Suggested toolset to view and edit this Markdown file: