Metadata-Version: 2.3
Name: osrs_tui
Version: 0.3.0
Summary: A package for doing great things!
License: MIT
Author: Dylan Garrett
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: python-dotenv (>=1.2.2,<2.0.0)
Requires-Dist: requests (>=2.33.1,<3.0.0)
Requires-Dist: textual (>=8.2.4,<9.0.0)
Description-Content-Type: text/markdown

# osrs_tui

A package for doing great things!

## Installation

```bash
$ pip install osrs_tui
```

> **NOTE**: If you would like to run this application from the terminal, you will need to perform a system wide installation:
```bash
$ sudo pip install osrs_tui
```

## Usage

There are two viable options for launching this application. 

### Terminal Command (Easy)

```bash
$ osrs-tui
```

### Importing the toplevel module directly (Hard*er*)

The above terminal command is essentially the same as executing the following:
```bash
$ python -m osrs_tui
```

### Navigating the App

The initial home screen will give you a single text-input field and a dropdown selection field for your *username* and *account type*. Enter your character's information here and submit to get a detailed view of your skills and their stats. 

From here (the **Skills Screen**), you can press the "C" key to launch the Skill Calculator screen.

> Press Ctrl+Q at any time to quit.


## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`osrs_tui` was created by Dylan Garrett. It is licensed under the terms of the MIT license.

## Credits

`osrs_tui` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

