Metadata-Version: 2.1
Name: hmrsplanner
Version: 0.0.5
Summary: Planner for Heterogeneous Multi-Robots Systems
Home-page: https://github.com/gabrielsr/hmrsplanner
Author: Gabriel Rodrigues
Author-email: gabrielsr@gmail.com
License: UNKNOWN
Description: [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b9b2abf80de34584a596147b099f4473)](https://app.codacy.com/gh/gabrielsr/HMRSplanner?utm_source=github.com&utm_medium=referral&utm_content=gabrielsr/HMRSplanner&utm_campaign=Badge_Grade_Settings)
        [![Build Status](https://travis-ci.org/gabrielsr/hmrssim.svg?branch=master)](https://travis-ci.org/gabrielsr/HMRSplanner)
        [![codecov](https://codecov.io/gh/gabrielsr/hmrssim/branch/master/graph/badge.svg)](https://codecov.io/gh/gabrielsr/HMRSplanner)
        
        
        Heterogeneous Multi-Robots Systems Planner
        ======================================================
        
        Env Depencies
        -------------
        python 3, pip
        
        Used IDE: vscode, plugin python
        
        Instal pipenv
        ------------- 
        
        pipenv easy the process of managing python dependencies
        
        PIP
        ```console
        $ pip install pyenv
        ```
        
        Alternatively, macOS brew
        ```console
        $ brew install pipenv 
        ```
        
        Install dependencies
        --------------------
        
        Inside the project folder (after clone)
        
        ```console
        $ pyenv install 3.8.2
        $ pip install pipenv
        $ pipenv install
        $ pipenv shell
        (gmrs env) % pipenv install --dev
        ```
        
        Run
        ---
        
        Select the exec shell
        
        ```console
        $ pipenv shell
        ```
        
        Then, Execute Simulation
        
        ```console
        $ python ./simulator/run.py
        ```
        
        Test
        ----
        
        Tests should be put on /tests folder and are executed with the following command.
        
        ```console
         $ pytest -v --cov .
        ```
        
        Linter
        ------
        
        ```console
         $ flake8 --statistics
        ```
        
        Dependency
        ----------
        
        Add New Dependency
        ------------------
        
        To add new dependencies use the following command.
        
        ```console
        $ pipenv install [name]
        ```
        
        This command will add the dependency to the Pipfile and Pipfile.lock assuring that the execution can be reproduced in another environment (after dependencies are updated with `pipenv install` command )
        
        Add New Dev Dependency
        ----------------------
        Same as previous dependencies, but for development libraries such as the ones used for test.
        
        ```console
        $ pipenv install [name] --dev
        ```
        Note that other systems after pulling updates will need a reexecution of `pipenv install --dev`
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
