Skip to content

Commit

Permalink
Add Makefile to simplify the building, testing procedures.
Browse files Browse the repository at this point in the history
Signed-off-by: MICHELE GAZZETTI <[email protected]>
  • Loading branch information
mgazz committed Feb 2, 2024
1 parent ffb6f85 commit 3d5bbb6
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
16 changes: 16 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright IBM Corp. 2023
# This software is available to you under a BSD 3-Clause License.
# The full license terms are available here: https://github.com/OpenFabrics/sunfish_library_reference/blob/main/LICENSE

all: build

build:
poetry build

test:
python3 -m pytest tests/test_sunfishcore_library.py -vvvv

clean:
rm -r dist


20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,29 @@ The library requires:
- Python (version>=3.9)
- Poetry

## To generate the installation file
From the directory ```sunfish_library_reference``` execute the following command:
```
poetry build #This command will create the .whl file
```

## Installation

We suggest using a Python virtual environment.
We suggest using a Python virtual environment.
To install the project requirements:
```
pip install -r requirements.txt
```
To install sunfish you need to use the file .whl:
```
pip3 install dist/sunfish-0.1.0-py3-none-any.whl

## To generate the installation file
From the directory ```sunfish_library_reference``` execute the following command:
```
make build
```


## Tests
To test this Library you need ```pytest``` to be installed.
To run the tests run the command
```
python3 -m pytest test_sunfishcore_library.py -vvvv
make test
```


## Usage
To use sunfishcorelib you need to specify the **configuration parameters** into the conf.json file, an example could be:
```
Expand Down

0 comments on commit 3d5bbb6

Please sign in to comment.