Skip to content

Commit ae0199e

Browse files
committed
Add running locally and pbd to the guide
1 parent 20bb222 commit ae0199e

File tree

3 files changed

+64
-0
lines changed

3 files changed

+64
-0
lines changed

docs/development.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,31 @@ If you are having problems,
7676
you can check the logs at ``~/.local/share/lira/log/lira.log``,
7777
or at ``~/AppData/Local/lira-data/log/lira.log`` if you are using Windows.
7878

79+
To debug with the lira's terminal interface running you may need
80+
`python-remote-pdb <https://github.com/ionelmc/python-remote-pdb>`__,
81+
install it with:
82+
83+
.. code-block:: bash
84+
85+
pip install remote-pdb
86+
87+
It works just as pdb, import it with:
88+
89+
.. code-block:: python
90+
91+
from remote_pdb import set_trace
92+
set_trace()
93+
94+
And to connect to it from another terminal:
95+
96+
.. code-block:: bash
97+
98+
telnet 127.0.0.1 4444
99+
100+
For more insights about it, please read the
101+
`python-remote-pdb <https://github.com/ionelmc/python-remote-pdb>`__
102+
documentation.
103+
79104
Roadmap
80105
-------
81106

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,6 @@ Contents
3434
:maxdepth: 2
3535

3636
config.rst
37+
install.rst
3738
development.rst
3839
modules/index.rst

docs/install.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Install
2+
=======
3+
4+
From Source
5+
-----------
6+
7+
To install lira directly from the GitHub repository.
8+
9+
.. code-block:: bash
10+
11+
python -m pip install git+https://github.com/pythonecuador/lira
12+
13+
14+
Pipx
15+
----
16+
17+
Pipx allows you to run Python applications in isolated environments,
18+
check out the documentation `here <https://pipxproject.github.io/pipx/>`__.
19+
20+
Install pipx with pip.
21+
22+
.. code-block:: bash
23+
24+
pip install pipx
25+
26+
Then, add pipx to the PATH.
27+
28+
.. code-block:: bash
29+
30+
python -m pipx ensurepath
31+
32+
It will ask you to restart your terminal,
33+
then install lira.
34+
35+
.. code-block:: bash
36+
37+
pipx install lira
38+

0 commit comments

Comments
 (0)