ose-workbench-platform 0.1.0a27

Common platform for developing Open Source Ecology (OSE) workbenches.

OSE Workbench Platform

• Introduction
• Pre-Requisites
• Installation
• Virtual Development Environment
• Unit Tests
• Documentation
• Commands
  • test
  • lint
  • docs
  • make
  • browse
• Contributing
• License

Introduction

A platform for developing workbenches for Open Source Ecology (OSE).

OSE defines a "workbench" as a set of tools in CAD software to design and make a particular machine.

Each workbench OSE develops for one of it's machines has certain common development-time or "dev-time" needs and dependencies.

For example, running unit tests, making documentation, and generating code to streamline workbench development.

Rather than duplicate the approaches to each of these needs, ose-workbench-platform abstracts those needs into a common platform so they aren't the concern of individual OSE workbench maintainers.

Each workbench maintainer doesn't need to know or care about the particular versions and libraries we use to solve those needs, nor the particular configuration.

Having a common platform for OSE workbench development also makes it easier for developers to readily switch between workbenches by providing a common tool-set.

ose-workbench-platform provides a command-line interface (CLI), via the osewb command, containing commands for common dev-time tasks such as running all tests, making documentation, initializing new workbenches, and even generating code for common tasks.

Pre-Requisites

1. Install Git
2. Install Miniconda

Installation

Install the ose-workbench-platform package from the gbroques channel in a dedicated conda environment named osewb (short for Open Source Ecology WorkBench) and don't ask for confirmation:

conda create --name osewb --channel gbroques --yes ose-workbench-platform

Activate your new osewb environment:

conda activate osewb

Test your installation:

osewb --help

You can deactivate this environment later by running:

conda deactivate

Virtual Development Environment

We use Conda to create a reproducible virtualized OSE workbench development environment with requisite dependencies for development-time tasks like running FreeCAD, executing unit tests, and generating documentation from source-code comments.

In order to perform various development-time tasks for a workbench, you must first:

1. Create a conda environment from the environment.yml file located in the root of the workbench repository
2. Activate the environment with conda activate <environment name>

Note, each workbench will have it's own separate environment.

Workbench environments will be named after the base package in the workbench repository (e.g. ose3dprinter, osetractor, osepowercube, etc.).

Some common commands relating to managing environments with conda are documented in the below table.

Description	Command
Creating the environment	conda env create --file environment.yml
Activating the environment	conda activate <environment name>
Deactivating the environment	conda deactivate

Refer to the Conda CLI reference documentation for additional information.

Unit Tests

For running unit tests we use pytest.

For test coverage, we use coverage.py and pytest-cov.

Documentation

For building documentation, we use Sphinx.

For hosting documentation, we use a free service for open-source projects called Read the Docs.

For a modern and mobile-friendly look, we use Read the Docs Sphinx Theme.

Commands

The osewb command contains various sub-commands for performing common dev-time tasks of a OSE workbench.

$ osewb -h ↵
usage: osewb <command> [<args>]

A collection commands for OSE workbench development.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

Commands:
  {test,lint,docs,make,browse,br}
    test                Run tests in workbench
    lint                Lint code
    docs                Make documentation
    make                Commands for making new code
    browse (br)         Commands for opening documents in a web browser

Each sub-command may have flags and arguments, and additional information can be discovered via osewb <command> -h or --help.

Is osewb too many characters to type? We recommend aliasing the osewb command as ose to reduce typing and increase speed even further.

For further convenience, any command over four characters shall include a short-alias under four characters or less. For example, br is the short-alias for the five-character browse command.

test

OSE Workbench Platform includes a test command for interacting with the test-suite of a workbench.

$ osewb test -h ↵
usage: osewb test

optional arguments:
  -h, --help      show this help message and exit
  -c, --coverage  Run tests with coverage, and generate report

To run the entire unit-test suite for a workbench, run:

osewb test

For running tests with coverage and generating a coverage report, pass the -c or --coverage flag to the test command:

osewb test --coverage

lint

OSE Workbench Platform includes a lint command for linting the code of a workbench.

osewb lint

The lint command will:

• Run flake8 with configuration located in .flake8.
• Run mypy for static type checking with configuration located in .mypy.ini.

For automatically fixing some linter issues, pass the -f or --fix flag to the lint command:

osewb lint --fix

This will run isort and autopep8 recursively on the root of the workbench repository.

For additional information, see:

• flake8
• mypy

docs

OSE Workbench Platform includes a docs command for building the documentation of a workbench.

osewb docs

The docs command will:

• Delete the docs/_build/ directory
• Delete the docs/<base package>/ directory
• Re-generate docs/_build/ and docs/<base package>/ by running sphinx-build . _build within docs/ using the Sphinx configuration specified in docs/conf.py
• Generate property tables for each Model class in the workbench and output them as .csv files in docs/property_table/

For additional information, see sphinx-build and Sphinx Configuration.

make

OSE Workbench Platform includes a make command for "making" new code.

$ ose make -h ↵
usage: osewb make <command>

optional arguments:
  -h, --help           show this help message and exit

Commands:
  {workbench,wb,part}
    workbench (wb)     Make Workbench
    part               Make Part class

workbench

Navigate to where you want to create your new workbench. Then run:

osewb make workbench <machine_display_name>

Where <machine_display_name> is the name of the machine in Title Case. If this contains spaces, then surround the value in double-quotes "".

$ osewb make workbench Tractor ↵
Workbench initialized in "ose-tractor-workbench" directory.

Perform the following commands to get started:

1. Change directories and initialize the git repository:

    cd ose-tractor-workbench && git init

2. Create a conda environment and activate it:

    conda env create --file environment.yml && conda activate osetractor

3. Verify your installation:

    osewb -h

The above examples initializes a new workbench, in a ose-tractor-workbench directory, with the basic structure and files needed.

TODO: The below tree diagram needs to be updated.

$ tree ose-tractor-workbench --dirsfirst ↵
ose-tractor-workbench
├── docs
│   ├── _static
│   ├── _templates
│   │   ├── package.rst_t
│   │   └── toc.rst_t
│   ├── conf.py
│   ├── index.rst
│   └── requirements.txt
├── freecad
│   └── osetractor
│       ├── command
│       │   ├── add_box
│       │   │   ├── add_box_command.py
│       │   │   └── __init__.py
│       │   └── __init__.py
│       ├── icon
│       │   ├── Box.svg
│       │   └── __init__.py
│       ├── init_gui.py
│       ├── __init__.py
│       └── register_commands.py
├── osetractor
│   ├── part
│   │   ├── box
│   │   │   ├── box.py
│   │   │   └── __init__.py
│   │   └── __init__.py
│   └── __init__.py
├── tests
│   ├── box_test.py
│   └── __init__.py
├── CONTRIBUTING.md
├── environment.yml
├── LICENSE
├── MANIFEST.in
├── README.md
└── setup.py

12 directories, 25 files

For more information, see the Pattern Catalog in the docs.

part

Within the repository of a workbench, run the osewb make part command to make a new Part Class.

For example,

osewb make part Box

Makes a new Box part class.

For more information, see Part Classes in the docs.

browse

OSE Workbench Platform includes a browse covenience command for opening documentation and coverage reports in a web browser.

$ osewb browse -h ↵
usage: osewb browse <command>

optional arguments:
  -h, --help           show this help message and exit

Commands:
  {docs,coverage,cov}
    docs               Opens docs in web browser
    coverage (cov)     Opens coverage report in web browser

The docs command opens docs/_build/index.html in a web browser, while coverage opens htmlcov/index.html in a web browser.

Contributing

See Contributing Guidelines.

License

Licensed under the GNU Lesser General Public License, version 2.1 or LGPL v2.1. See LICENSE for details.

This is the same license as FreeCAD to ensure this code could potentially be incorporated into future FreeCAD modules or FreeCAD source itself.