Skip to content

Latest commit

 

History

History
68 lines (52 loc) · 2.67 KB

README.md

File metadata and controls

68 lines (52 loc) · 2.67 KB

Relic Tool - Core

PyPI PyPI - Python Version PyPI - License linting: pylint Checked with mypy Code style: black Pytest Pylint MyPy

Description

The core library used by other Relic-Tool packages.

Usage

From the Command Line Interface

While the core library does not define any commands; it does define the command line. To discover installed commands, run the following.

relic -h

From Python Code

Commands can also be run directly from the library; To discover installed commands, run the following.

from relic.core import CLI

exit_status = CLI.run_with('-h')

Troubleshooting

No Commands are installed!

The core package does not define any CLI functionality itself.

If no options are specified, check to see if other Relic-Tool packages are installed that offer command line integration.

You can do this by running the following:

python -m pip list

And looking for relic-tool-... in the command's output.

If you only see relic-tool-core, you need to install the desired Relic-Tool package the command belongs to.

Installation (Pip)

Installing from PyPI (Recommended)

pip install relic-tool-core

Installing from GitHub

For more information, see pip VCS support

pip install git+https://github.com/MAK-Relic-Tool/Relic-Tool-Core

I Have an Issue / Found a Bug

Click the link above, to visit the Issue Tracker

Disclaimer

Not affiliated with Sega, Relic Entertainment, or THQ.