Installation
===================

pji is currently hosted on PyPI. It required python >= 3.6.

You can simply install pji from PyPI with the following command:

.. code:: shell

    pip install pji

You can also install with the newest version through GitHub:

.. code:: shell

    pip install -U git+https://github.com/hansbug/pji.git@main

You can check your installation by the following python \
script:

.. literalinclude:: install_check.demo.py
    :language: python
    :linenos:

The output should be like below, which means your installation \
is successful.

.. literalinclude:: install_check.demo.py.txt
    :language: text
    :linenos:

In addition, you can also use the pji command line tool directly \
to test and view the version.

.. literalinclude:: pji_cli.demo.sh
    :language: shell
    :linenos:

The output should be

.. literalinclude:: pji_cli.demo.sh.txt
    :language: text
    :linenos:

pji is still under development, you can also check out the \
documents in stable version through `https://hansbug.github.io/pji/ <https://hansbug.github.io/pji/>`_.