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

``hfmirror`` is currently hosted on PyPI. It required python >= 3.7.

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

.. code:: shell

    pip install hfmirror

You can also install with the newest version through GitHub:

.. code:: shell

    pip install -U git+https://github.com/narugo1992/hfmirror.git@main

After installation, run this python code, and version information \
of ``hfmirror`` should be shown.

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

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

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