Metadata-Version: 2.1
Name: east-tool
Version: 0.6.1
Summary: Tool built on top of West for managing nRF Connect SDK projects.
Author-email: Marko Sagadin <marko.sagadin42@gmail.com>
License: MIT License
        
        Copyright (c) [year] [fullname]
        
        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.
        
Project-URL: Homepage, https://github.com/IRNAS/irnas-east-software
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# East tool

## Installation and updating

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install East.

```bash
pip install --upgrade east-tool
```

## Usage

`east` intends to be fully documented inside the tool itself, (which is not
yet). Executing `east` or `east --help` in the command line should give you
sufficient information on how to use the tool in basic ways.

To learn more about configuration refer to the [docs](docs) folder.


## Developing East

For development and testing of `east` the use of `virtualenv` is suggested.

Install `virtualenv`:

```bash
pip install virtualenv
```

Create and activate `virtualenv`, run this from project root:

```bash
virtualenv venv
source venv/bin/activate
```

To create and editable install of `east` run below command. Whatever change you
make in the code it will be immediately reflected in the actual tool.

```bash
make install-dev
```

### Running unit tests

```bash
make test
```

#### Editable install does not work

If `make install` (more exactly `pip install -e .`) ever misbehaves, it is
probably due to this: https://github.com/pypa/pip/issues/7953.

Run below command once and then again `make install`, this fixed it last time:

```bash
python3 -m pip install --prefix=$(python3 -m site --user-base) -e .
```

#### Test for version check fails

This happens if the `make install-dev` command was not run before running `make test`.
