Metadata-Version: 2.1
Name: accli
Version: 0.7.6
Summary: IIASA Accelerator Client
Author-email: Wrufesh S <wrufesh@gmail.com>
License: The MIT License (MIT)
        
        Copyright (c) 2018 Sebastián Ramírez
        
        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/iiasa/accli
Project-URL: Bug Tracker, https://github.com/iiasa/accli/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3 >=1.26.5
Requires-Dist: typer[all] >=0.4.0
Requires-Dist: tinydb >=4.5.2
Requires-Dist: requests >=2.25.1
Requires-Dist: jsonschema >=4.5.1
Requires-Dist: pydantic >=2.0
Requires-Dist: gitpython >=3.1.30

# Accelerator terminal client and Python API

Provides a command-line client for interacting with the Accelerator as well as a Python API in the form of the `accli` package. These communicate with the rest API of the Accelerator [Control Services Backend](https://github.com/iiasa/control_services_backend).

Uses device authentication:
- Part 0Auth: [Device Authentication Flow](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow).
- Auth valid for 7 days.
- Grants are limited.
- Access via RBAC:
  * Stateless tokens.

## User Guide

**Requirements**
* Python >=3.7.17

**Installation**

`pip install accli --user`

**Usage as module**

`python -m accli`

**Usage as executable**

*You might receive following similar warning during installation*
```
 WARNING: The script accli.exe is installed in 'C:\Users\singhr\AppData\Roaming\Python\Python311\Scripts' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
```

*You could also add executable directory path in PATH environment variable. Please follow following links for instruction on adding executable directory path to PATH environemnt variable.*

[Updating PATH on windows](https://stackoverflow.com/questions/44272416/how-to-add-a-folder-to-path-environment-variable-in-windows-10-with-screensho)

[Updating PATH on linux](https://www.geeksforgeeks.org/how-to-set-path-permanantly-in-linux/)

**Command**

`accli --help`

*Output*

`Usage: accli [OPTIONS] COMMAND [ARGS]...`

*Note: You may need to prepend the command with either `./`(in linux) or `.\`(in winodws).*


## Developer Guide
**General build and upload instructions**
Please follow [this link.](https://packaging.python.org/en/latest/tutorials/packaging-projects/)

**Release process**
1. Commit with right version on accli/_version.py
2. Run 'python scripts/tag.py'
3. `python -m build`
4. `twine upload -r pypi -u __token__ -p <password-or-token> ./dist/*`


#TODO nuitka --standalone --onefile --static-libpython=yes --include-package=accli --output-dir=build -m accli.cli:app
