Metadata-Version: 2.1
Name: SRIndexProto
Version: 0.2.0
Summary: Default template for PDM package
Author-Email: nunininu <sgcho0907@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/nuni-org/SRIndexProto
Project-URL: Issues, https://github.com/nuni-org/SRIndexProto/issues
Requires-Python: >=3.10
Requires-Dist: typer>=0.15.1
Description-Content-Type: text/markdown

# SRIndexProto
- Prototype of calculator for Social Relationship Index 

# Use
```bash
$ srindex --help

 Usage: srindex [OPTIONS] GIVE_AND_TAKE CELEBRATION FREQ_CALL FREQ_MEETING

╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    give_and_take      INTEGER  [default: None] [required]                                                                                   │
│ *    celebration        INTEGER  [default: None] [required]                                                                                   │
│ *    freq_call          INTEGER  [default: None] [required]                                                                                   │
│ *    freq_meeting       INTEGER  [default: None] [required]                                                                                   │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                                                   │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

$ srindexproto 1 1 1 1
(71, 1, 61, 40)
$ srindexproto 1 1 1 1
(62, 1, 32, 92)
```

## Requirements
```bash
To calculate the Index, you need arguments below:
- give_and_take
- celebration
- freq_call
- freq_meeing

and set weight of each arguments in range: 
- 0 < weight1 < 1, = w1
- 0 < weight2 < 1, = w2
- 0 < weight3 < 1, = w3
- 0 < weight4 < 1, = w4
and summation of all weight(w1+w2+w3+w4) must be equal to 1
```

```bash
## Development environment setting guide

# install PDM
# git clone ...
# pdm venv create
$ source .venv/bin/activate
$ pdm install
# $ vi ...

# TEST
$ pdm install
$ pdm test
$ pip install .

$ git add <FILE_NAME>
$ git commit -a
$ git push
$ pdm publish --username __token__ --password $PYPI_TOKEN
```
