mooreio-client 2.0.2__tar.gz

mooreio_client-2.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Datum Technology Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mooreio_client-2.0.2/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.1
+Name: mooreio_client
+Version: 2.0.2
+Summary: CLI tool to automate EDA tasks for ASICs, FPGAs, and UVM IP.
+Home-page: https://github.com/Datum-Technology-Corporation/mooreio_client
+Author: Datum Technology Corporation
+Author-email: info@datumtc.ca
+License: MIT
+Project-URL: Documentation, https://readthedocs.org/projects/mooreio-client/
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: docutils~=0.19
+Requires-Dist: requests~=2.31.0
+Requires-Dist: pydantic~=2.9.2
+Requires-Dist: semantic-version~=2.10.0
+Requires-Dist: PyYAML~=6.0
+Requires-Dist: Jinja2~=3.1.2
+Requires-Dist: toml~=0.10.2
+Requires-Dist: pydantic-extra-types==2.9.0
+Requires-Dist: semver==3.0.2
+Requires-Dist: tqdm==4.67.1
+Provides-Extra: dev
+Requires-Dist: flake8>=7.1.1; extra == "dev"
+Requires-Dist: mccabe>=0.7.0; extra == "dev"
+Requires-Dist: pycodestyle>=2.12.1; extra == "dev"
+Requires-Dist: pyflakes>=3.2.0; extra == "dev"
+Requires-Dist: coverage>=7.6.1; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: pytest>=8.3.3; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6.1; extra == "dev"
+Requires-Dist: pytest-metadata>=3.1.1; extra == "dev"
+Requires-Dist: flake8-html>=0.4.3; extra == "dev"
+Requires-Dist: pygments>=2.18.0; extra == "dev"
+Requires-Dist: pytest-html>=4.1.1; extra == "dev"
+Requires-Dist: pytest-flake8>=1.3.0; extra == "dev"
+Requires-Dist: setuptools>=65.5.0; extra == "dev"
+
+![Moore.io Client Logo](https://mooreio.com/dab41100c71545e7520e.png)
+
+# Moore.io Client
+
+The Moore.io Client is an open-source CLI tool designed to automate Electronic Design Automation (EDA) tasks encountered
+during the development of ASIC, FPGA and UVM IP. This tool also serves as a client for the Moore.io Web Site
+(https://mooreio.com), providing functionalities such as installing IP dependencies, generating UVM code and
+packaging/publishing IPs.
+
+## Why?
+The EDA (Electronic Design Automation) field clearly lags behind in terms of Free & Open-Source (FOS) developer tools
+when compared to the software world. There is no FOS tool that can drive the various CAD software necessary and provide
+the kind of automation needed to produce commercial-grade FPGA and ASIC designs. Instead, homebrew (and seldom shared)
+Makefiles and Shell scripts rule the field of DevOps in semiconductors.
+
+### The Problem
+Writing a Makefile/Shell script that can perform all the tasks required to create a Chip Design is a LARGE job. Since
+these languages do not come with any meaningful libraries, the end result is a mess of patched, brittle code painful to
+maintain/debug, yet on which every engineering task directly depends. These issues are usually compounded by
+copying the project Makefile/Shell script from project to project; thus losing all Git history while commenting
+out old code and adding to the mess.
+
+Surely, there must be a better way ...
+
+### The Solution
+The Moore.io Client is a FOS Command Line Interface (CLI) tool implemented in Python 3, using Object-Oriented
+Practices, strong typing, unit testing, and a modular architecture that will be very familiar to UVM engineers: the
+primary target audience of this tool. The Client, invoked via `mio`, has all the features you would expect from a
+"Project Makefile" at a high-end Semiconductor engineering firm AND all the best features from Software package
+managers:
+
+ * The concept of a Project, which is identified by a `mio.toml` file in its root directory
+ * A layered Configuration Space defined with TOML files (`mio.toml`) at the user (`~/.mio/mio.toml`) and project levels
+ * Packaging of HDL source file into IPs (Intellectual Property) identified by `ip.yml` descriptors in their root directory
+ * Performing tasks at the IP-level, including generating code, specifying and installing dependencies
+ * Ability to drive all Logic Simulators (VCS, XCelium, Questa, Vivado, Metrics DSim, Riviera-PRO) with a single set of commands and parameters
+ * A feature-driven Test Suite schema for specifying Regressions in UVM Test Benches, AND the ability to run these Regressions on Job Schedulers (LSF, GRID, etc.)
+ * Built-in compatibility with Continuous Integration (CI) tools like Jenkins
+
+## How much does it cost?
+The EDA Automation and Package management is Free & Open-Source. Some commands, such as UVM Code Generation, "phone
+home" to the Moore.io Server and therefore require a User Account (which can be created at
+https://mooreio.com/register) and a license for Datum UVMx. However, the tool operates independently of the site in all
+other regards and can be used without authentication to build a Chip from start to finish. 
+
+
+## Installation
+
+You can install `mio` via `pip`:
+
+```sh
+pip install mooreio_client
+```
+
+## Usage
+
+```sh
+mio <command> [<args>]
+mio help <command>
+```
+
+For complete list of commands and options, you can use:
+
+```sh
+mio --help
+```
+
+For quick reference on a specific command:
+
+```sh
+mio help <command>
+```
+
+## Documentation
+
+Comprehensive documentation is available on [Read the Docs](https://readthedocs.org/projects/mooreio_client).
+
+## Development
+
+### Architecture
+The Design Pattern for the Moore.io Client mimics UVM's phases and component structure. A RootManager (RM) class instance
+is created by the CLI argument parser and given a Command instance to execute. The RM operates in 3 steps:
+
+1. Discovery: finding the project file, loading/validating the configuration space and finding/loading IP files
+2. Main: RM gives control to the Command which invokes Service(s) (simulators, synthesizers, etc.) to perform Task(s) (compilation, simulation, etc.) via a JobScheduler instance (SubProcess, LSF, GRID) which accepts Jobs (shell commands) 
+3. Post: RM and Command parse results, generate reports, clean up files, close sockets, stop processes and print out final notes to the user  
+
+Each step is broken up into phases, with each phase having a 'pre' and 'post' phase associated to it:
+
+* The Discovery step is handled by the RM; the Command can participate via pre/post phase hooks
+* During the Main phase, control shifts to the Command, which has a selection of Service tasks and JobSchedulers with which to run them
+* The post step is shared between the RM and the Command
+
+Each phase method has a Phase instance parameter that can be used to end the program arbitrarily and/or report errors to the RM.
+
+Commands are discovered by `cli.py` and must append their CLI argument subparser to the main `argparse` instance.
+If the user selects the command, an instance is created, fed to the RM and execution begins via `RM.run()`.
+
+Errors are handled via the `raise` of Python Exceptions. The RM catches these and exits with the appropriate error message and return code.
+
+
+### Requirements
+
+- Python 3.11.4
+- `pip` package manager
+- `make` utility (for convenience in development and CI)
+
+### Setup
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/Datum-Technology-Corporation/mooreio_client.git
+    cd mooreio_client
+    ```
+
+2. Set up Virtual Environment and install Dependencies:
+    ```sh
+    make venv
+    ```
+
+3. Run tests:
+    ```sh
+    make test
+    ```
+
+4. Build documentation:
+    ```sh
+    make docs
+    ```
+
+5. Build package:
+    ```sh
+    make build
+    ```
+
+6. Print Makefile User Manual:
+    ```sh
+    make help
+    ```
+
+## Continuous Integration
+Most popular CI/CD tools are supported out-of-the-box. Some systems are better fleshed out than others; please don't
+hesitate to contribute your tweaks!
+
+### Supported Continuous Integration Tools
+- Azure Pipelines
+- Bamboo
+- Bitbucket Pipelines
+- CircleCI
+- Codeship
+- GitHub Actions
+- GitLab CI/CD
+- Jenkins
+- TeamCity
+- Travis CI
+
+## Contributing
+
+We welcome contributions! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+- Official site: [www.mooreio.com](http://www.mooreio.com)
+- Copyright Holder: [Datum Technology Corporation](http://www.datumtc.ca)

mooreio_client-2.0.2/README.md

@@ -0,0 +1,168 @@
+![Moore.io Client Logo](https://mooreio.com/dab41100c71545e7520e.png)
+
+# Moore.io Client
+
+The Moore.io Client is an open-source CLI tool designed to automate Electronic Design Automation (EDA) tasks encountered
+during the development of ASIC, FPGA and UVM IP. This tool also serves as a client for the Moore.io Web Site
+(https://mooreio.com), providing functionalities such as installing IP dependencies, generating UVM code and
+packaging/publishing IPs.
+
+## Why?
+The EDA (Electronic Design Automation) field clearly lags behind in terms of Free & Open-Source (FOS) developer tools
+when compared to the software world. There is no FOS tool that can drive the various CAD software necessary and provide
+the kind of automation needed to produce commercial-grade FPGA and ASIC designs. Instead, homebrew (and seldom shared)
+Makefiles and Shell scripts rule the field of DevOps in semiconductors.
+
+### The Problem
+Writing a Makefile/Shell script that can perform all the tasks required to create a Chip Design is a LARGE job. Since
+these languages do not come with any meaningful libraries, the end result is a mess of patched, brittle code painful to
+maintain/debug, yet on which every engineering task directly depends. These issues are usually compounded by
+copying the project Makefile/Shell script from project to project; thus losing all Git history while commenting
+out old code and adding to the mess.
+
+Surely, there must be a better way ...
+
+### The Solution
+The Moore.io Client is a FOS Command Line Interface (CLI) tool implemented in Python 3, using Object-Oriented
+Practices, strong typing, unit testing, and a modular architecture that will be very familiar to UVM engineers: the
+primary target audience of this tool. The Client, invoked via `mio`, has all the features you would expect from a
+"Project Makefile" at a high-end Semiconductor engineering firm AND all the best features from Software package
+managers:
+
+ * The concept of a Project, which is identified by a `mio.toml` file in its root directory
+ * A layered Configuration Space defined with TOML files (`mio.toml`) at the user (`~/.mio/mio.toml`) and project levels
+ * Packaging of HDL source file into IPs (Intellectual Property) identified by `ip.yml` descriptors in their root directory
+ * Performing tasks at the IP-level, including generating code, specifying and installing dependencies
+ * Ability to drive all Logic Simulators (VCS, XCelium, Questa, Vivado, Metrics DSim, Riviera-PRO) with a single set of commands and parameters
+ * A feature-driven Test Suite schema for specifying Regressions in UVM Test Benches, AND the ability to run these Regressions on Job Schedulers (LSF, GRID, etc.)
+ * Built-in compatibility with Continuous Integration (CI) tools like Jenkins
+
+## How much does it cost?
+The EDA Automation and Package management is Free & Open-Source. Some commands, such as UVM Code Generation, "phone
+home" to the Moore.io Server and therefore require a User Account (which can be created at
+https://mooreio.com/register) and a license for Datum UVMx. However, the tool operates independently of the site in all
+other regards and can be used without authentication to build a Chip from start to finish. 
+
+
+## Installation
+
+You can install `mio` via `pip`:
+
+```sh
+pip install mooreio_client
+```
+
+## Usage
+
+```sh
+mio <command> [<args>]
+mio help <command>
+```
+
+For complete list of commands and options, you can use:
+
+```sh
+mio --help
+```
+
+For quick reference on a specific command:
+
+```sh
+mio help <command>
+```
+
+## Documentation
+
+Comprehensive documentation is available on [Read the Docs](https://readthedocs.org/projects/mooreio_client).
+
+## Development
+
+### Architecture
+The Design Pattern for the Moore.io Client mimics UVM's phases and component structure. A RootManager (RM) class instance
+is created by the CLI argument parser and given a Command instance to execute. The RM operates in 3 steps:
+
+1. Discovery: finding the project file, loading/validating the configuration space and finding/loading IP files
+2. Main: RM gives control to the Command which invokes Service(s) (simulators, synthesizers, etc.) to perform Task(s) (compilation, simulation, etc.) via a JobScheduler instance (SubProcess, LSF, GRID) which accepts Jobs (shell commands) 
+3. Post: RM and Command parse results, generate reports, clean up files, close sockets, stop processes and print out final notes to the user  
+
+Each step is broken up into phases, with each phase having a 'pre' and 'post' phase associated to it:
+
+* The Discovery step is handled by the RM; the Command can participate via pre/post phase hooks
+* During the Main phase, control shifts to the Command, which has a selection of Service tasks and JobSchedulers with which to run them
+* The post step is shared between the RM and the Command
+
+Each phase method has a Phase instance parameter that can be used to end the program arbitrarily and/or report errors to the RM.
+
+Commands are discovered by `cli.py` and must append their CLI argument subparser to the main `argparse` instance.
+If the user selects the command, an instance is created, fed to the RM and execution begins via `RM.run()`.
+
+Errors are handled via the `raise` of Python Exceptions. The RM catches these and exits with the appropriate error message and return code.
+
+
+### Requirements
+
+- Python 3.11.4
+- `pip` package manager
+- `make` utility (for convenience in development and CI)
+
+### Setup
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/Datum-Technology-Corporation/mooreio_client.git
+    cd mooreio_client
+    ```
+
+2. Set up Virtual Environment and install Dependencies:
+    ```sh
+    make venv
+    ```
+
+3. Run tests:
+    ```sh
+    make test
+    ```
+
+4. Build documentation:
+    ```sh
+    make docs
+    ```
+
+5. Build package:
+    ```sh
+    make build
+    ```
+
+6. Print Makefile User Manual:
+    ```sh
+    make help
+    ```
+
+## Continuous Integration
+Most popular CI/CD tools are supported out-of-the-box. Some systems are better fleshed out than others; please don't
+hesitate to contribute your tweaks!
+
+### Supported Continuous Integration Tools
+- Azure Pipelines
+- Bamboo
+- Bitbucket Pipelines
+- CircleCI
+- Codeship
+- GitHub Actions
+- GitLab CI/CD
+- Jenkins
+- TeamCity
+- Travis CI
+
+## Contributing
+
+We welcome contributions! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+- Official site: [www.mooreio.com](http://www.mooreio.com)
+- Copyright Holder: [Datum Technology Corporation](http://www.datumtc.ca)

mooreio_client-2.0.2/mio_client/__main__.py

@@ -0,0 +1,9 @@
+# Copyright 2020-2024 Datum Technology Corporation
+# All rights reserved.
+#######################################################################################################################
+import sys
+
+from mio_client.cli import main
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))

mooreio_client-2.0.2/mio_client/cli.py

@@ -0,0 +1,188 @@
+# Copyright 2020-2024 Datum Technology Corporation
+# All rights reserved.
+#######################################################################################################################
+import argparse
+import pathlib
+import sys
+import os
+
+from mio_client.commands import sim, ip, misc, project, team, user, web, gen
+from mio_client.core.root_manager import RootManager
+
+#######################################################################################################################
+# User Manual Top
+#######################################################################################################################
+VERSION = "2.0.2"
+
+HELP_TEXT = f"""
+                                        Moore.io (`mio`) Client - v{VERSION}
+                                   User Manual: https://mio-client.readthedocs.io/
+             https://mooreio.com - Copyright 2020-2024 Datum Technology Corporation - https://datumtc.ca
+Usage:
+  mio [--version] [--help]
+  mio [--wd WD] [--dbg] CMD [OPTIONS]
+
+Options:
+  -v, --version
+    Prints the mio version and exits.
+
+  -h, --help
+    Prints the overall synopsis and a list of the most commonly used commands and exits.
+
+  -C WD, --wd WD
+    Run as if mio was started in WD (Working Directory) instead of the Present Working Directory `pwd`.
+
+  --dbg
+    Enables tracing outputs from mio.
+
+Full Command List (`mio help CMD` for help on a specific command):
+   Help and Shell/Editor Integration
+      help           Prints documentation for mio commands
+      
+   Project and Code Management
+      init           Creates essential files necessary for new Projects/IPs
+
+   IP and Credentials Management
+      install        Installs all IP dependencies from IP Marketplace
+      login          Starts session with IP Marketplace
+      package        Creates a compressed (and encrypted) archive of an IP
+      publish        Publishes IP to Server (must have mio admin account)
+
+   EDA Automation
+      clean          Delete IP EDA artifacts and/or Moore.io Project directory contents (.mio)
+      sim            Performs necessary steps to simulate an IP with any simulator
+      regr           Runs regression against an IP
+      dox            Generates source reference documentation with Doxygen"""
+
+
+#######################################################################################################################
+# Main
+#######################################################################################################################
+URL_BASE = 'https://mooreio.com'
+URL_AUTHENTICATION = f'{URL_BASE}/auth/token'
+TEST_MODE = False
+USER_HOME_PATH = pathlib.Path(os.path.expanduser("~/.mio"))
+root_manager: RootManager
+def main(args=None) -> int:
+    """
+    Main entry point. Performs the following steps in order:
+    - Create CLI argument parser
+    - Find all commands and register them
+    - Parse CLI arguments
+    - Find the command which matches the parsed arguments
+    - Create the Root instance
+    - Run the command via the Root instance
+    :return: Exit code
+    """
+    global root_manager
+
+    try:
+        parser = create_top_level_parser()
+        subparsers = parser.add_subparsers(dest='command', help='Sub-command help')
+        commands = register_all_commands(subparsers)
+        args = parser.parse_args(args)
+    except Exception as e:
+        print(f"Error during parsing of CLI arguments: {e}", file=sys.stderr)
+        return 1
+
+    if args.version:
+        print_version_text()
+        return 0
+    if (not args.command) or args.help:
+        print_help_text()
+        return 0
+
+    command = next(
+        (
+            cmd for cmd in commands
+            if cmd.name().lower() == args.command
+        ),
+        None
+    )
+    if not command:
+        print(f"Unknown command '{args.command}' specified.", file=sys.stderr)
+        return 1
+
+    wd = None
+    if args.wd is None:
+        wd = pathlib.Path.cwd()
+    else:
+        try:
+            wd = pathlib.Path(args.wd).resolve()
+        except Exception as e:
+            print(f"Invalid path '{wd}' provided as working directory: {e}", file=sys.stderr)
+            return 1
+
+    root_manager = RootManager("Moore.io Client Root Manager", wd, URL_BASE, URL_AUTHENTICATION, TEST_MODE, USER_HOME_PATH)
+    command.parsed_cli_arguments = args
+
+    if args.dbg:
+        root_manager.print_trace = True
+
+    return root_manager.run(command)
+
+
+#######################################################################################################################
+# Helper functions
+#######################################################################################################################
+def create_top_level_parser():
+    """
+    Creates a top-level CLI argument parser.
+    :return: argparse.ArgumentParser object representing the top-level parser
+    """
+    parser = argparse.ArgumentParser(prog="mio", description="", add_help=False)
+    parser.add_argument("-h"   , "--help"   , help="Shows this help message and exits.", action="store_true", default=False, required=False)
+    parser.add_argument("-v"   , "--version", help="Prints version and exit."          , action="store_true", default=False, required=False)
+    parser.add_argument("--dbg",              help="Enable tracing output."            , action="store_true", default=False, required=False)
+    parser.add_argument("-C"   , "--wd"     , help="Run as if mio was started in <path> instead of the current working directory.", type=pathlib.Path, required=False)
+    return parser
+
+def register_all_commands(subparsers):
+    """
+    Register all commands to the subparsers.
+    :param subparsers: An instance of argparse.ArgumentParser that contains the subparsers.
+    :return: A list of registered commands.
+    """
+    commands = []
+    register_commands(commands, sim.get_commands())
+    register_commands(commands, ip.get_commands())
+    register_commands(commands, misc.get_commands())
+    register_commands(commands, project.get_commands())
+    register_commands(commands, team.get_commands())
+    register_commands(commands, user.get_commands())
+    register_commands(commands, web.get_commands())
+    register_commands(commands, gen.get_commands())
+    for command in commands:
+        command.add_to_subparsers(subparsers)
+    return commands
+
+def register_commands(existing_commands, new_commands):
+    """
+    Registers new commands into an existing list of commands.
+    :param existing_commands: A list of existing commands.
+    :param new_commands: A list of new commands to be registered.
+    :return: None
+    Raises:
+        ValueError: If a command name in `new_commands` is already registered in `existing_commands`.
+
+    """
+    new_command_names = {command.name for command in new_commands}
+    existing_command_names = {command.name for command in existing_commands}
+    for command in new_commands:
+        if command.name not in existing_command_names:
+            existing_commands.append(command)
+        else:
+            raise ValueError(f"Command '{command}' is already registered.")
+
+def print_help_text():
+    print(HELP_TEXT)
+
+def print_version_text():
+    print(f"Moore.io Client v{VERSION}")
+
+
+#######################################################################################################################
+# Entry point
+#######################################################################################################################
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))