Metadata-Version: 2.1
Name: ose-workbench-platform
Version: 0.1.0a7
Summary: Common platform for developing Open Source Ecology (OSE) workbenches.
Home-page: https://github.com/gbroques/ose-workbench-platform
Author: G Roques
License: UNKNOWN
Description: # OSE Workbench Platform
        [![PyPI version](https://badge.fury.io/py/ose-workbench-platform.svg)](https://badge.fury.io/py/ose-workbench-platform)
        
        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](https://git-scm.com/)
        2. Install [Python](https://www.python.org/)
        3. Install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/)
        
        ## Installation
        
            pip install ose-workbench-platform
        
        After installing, you'll have access to the `osewb` command:
        
        ```
        $ osewb -h ↵
        usage: osewb <command> [<args>]
            init - Initialize new workbench
            test - Run all tests in workbench
            docs - Make documentation
        
        A collection of OSE workbench commands.
        
        positional arguments:
          <command>   init, test, docs
        
        optional arguments:
          -h, --help  show this help message and exit
        ```
        
        ## Docker
        We use Docker to create a reproducible virtualized FreeCAD environment with requisite dependencies for development-time tasks like running unit tests with features like [coverage reports](https://en.wikipedia.org/wiki/Code_coverage), and generating documentation from source-code comments.
        
        ## Unit Tests
        For running unit tests we use [pytest](https://docs.pytest.org/en/latest/). For running tests with coverage and generating coverage reports, we use [coverage.py](https://coverage.readthedocs.io/en/latest/) and [pytest-cov](https://pytest-cov.readthedocs.io/en/latest/).
        
        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
        
        ## Documentation
        For building documentation we use [Sphinx](https://www.sphinx-doc.org/en/master/).
        
        To build the documentation for a workbench, run:
        
            osewb docs
        
        ## Initializing a New Workbench
        Navigate to where you want to initialize a directory for your new workbench. Then run:
        
            osewb init
        
        You'll be prompted to enter the machine name in **Title Case**.
        ```
        machine_display_name [CEB Brick Press]: Tractor ↵
        ```
        
        Then, you'll be prompted for several more values.
        
        Each successive prompt derives it's default value from answers to previous prompts.
        
        You can press the <kbd>Enter</kbd> key for most prompts to stick with the defaults.
        ```
        repo_name [ose-tractor-workbench]: ↵
        machine_title [OSE Tractor]: ↵
        workbench_title [OSE Tractor Workbench]: ↵
        base_package [osetractor]: ↵
        command_registry_filename [OSE-Tractor]: ↵
        command_namespace [OSETractor]: ↵
        workbench_class_filename [tractor_workbench]: ↵
        workbench_class_name [TractorWorkbench]: ↵
        ```
        
        The above examples initializes a new workbench, in a `ose-tractor-workbench` directory, with the basic structure and files needed for the workbench.
        
        ```
        ose-tractor-workbench
            ├── InitGui.py
            ├── osetractor
            │   ├── app
            │   │   ├── __init__.py
            │   │   └── part
            │   │       ├── box
            │   │       │   ├── box.py
            │   │       │   └── __init__.py
            │   │       └── __init__.py
            │   ├── gui
            │   │   ├── command
            │   │   │   ├── add_box
            │   │   │   │   ├── add_box_command.py
            │   │   │   │   └── __init__.py
            │   │   │   └── __init__.py
            │   │   ├── icon
            │   │   │   ├── Box.svg
            │   │   │   └── __init__.py
            │   │   ├── __init__.py
            │   │   ├── OSE-Tractor.py
            │   │   └── tractor_workbench.py
            │   └── __init__.py
            └── README.md
        ```
        
        ![OSE Tractor Workbench](./ose-tractor-workbench.png)
        
        ## Generating Code
        Within the root of a workbench repository, run the `make` command.
        
        For example,
        
            osewb make command AddMotor
        
        Will generate a new `AddMotor` command class.
        
        ## Developing Locally
        Run the following command from the root of the repository:
        
            pip install --editable .
        
        See ["Editable Installs"](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs) on the pip docs for additional information.
        
        This will give you access to the `osewb` command locally for testing any changes to the source code.
        
        ## Deploying to PyPi
        From the root of repository:
        
        1. `python setup.py sdist`
        
        2. `twine upload dist/*`
            * `pip install twine` (if not already installed)
        
        You'll be prompted for your [PyPi](https://pypi.org/) username and password:
        ```
        Enter your username: gbroques ↵
        Enter your password: ↵
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
