mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-04 08:24:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Document preference for pip install over setup.py.

Browse source
This commit is contained in:
Bob Hyman 2020-08-11 12:25:17 -04:00
parent fc492cad97
commit 224c555afe
5 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.rst
View file

@ -20,8 +20,11 @@ Making Your First Change
======================== ========================
First, install xonsh from source and open a xonsh shell in your favorite First, install xonsh from source and open a xonsh shell in your favorite
terminal application. See installation instructions for details. terminal application. See installation instructions for details, but it
is recommended to do an 'editable' install via `pip'
$ pip install -e .
Next, make a trivial change (e.g. ``print("hello!")`` in ``main.py``). Next, make a trivial change (e.g. ``print("hello!")`` in ``main.py``).
Finally, run the following commands. You should see the effects of your change Finally, run the following commands. You should see the effects of your change
@ -108,8 +111,7 @@ is open to interpretation.
* Simple functions should have simple docstrings. * Simple functions should have simple docstrings.
* Lines should be at most 80 characters long. The 72 and 79 character * Lines should be at most 80 characters long. The 72 and 79 character
recommendations from PEP8 are not required here. recommendations from PEP8 are not required here.
* All Python code should be compliant with Python 3.5+. At some * All Python code should be compliant with Python 3.5+.
unforeseen date in the future, Python 2.7 support *may* be supported.
* Tests should be written with `pytest <https://docs.pytest.org/>`_ using a procedural style. Do not use * Tests should be written with `pytest <https://docs.pytest.org/>`_ using a procedural style. Do not use
unittest directly or write tests in an object-oriented style. unittest directly or write tests in an object-oriented style.
* Test generators make more dots and the dots must flow! * Test generators make more dots and the dots must flow!

2
docs/linux.rst
View file

@ -28,7 +28,7 @@ the following from the source directory,
.. code-block:: console .. code-block:: console
$ python setup.py install $ pip install .
Debian/Ubuntu users can install xonsh from the repository with: Debian/Ubuntu users can install xonsh from the repository with:

2
docs/osx.rst
View file

@ -41,7 +41,7 @@ the following from the source directory,
.. code-block:: console .. code-block:: console
$ python3 setup.py install $ pip3 install xonsh
Extras for macOS Extras for macOS
================== ==================

2
docs/windows.rst
View file

@ -50,7 +50,7 @@ Now install xonsh:
.. code-block:: bat .. code-block:: bat
> cd xonsh-master > cd xonsh-master
> python setup.py install > pip install .
Next, run xonsh: Next, run xonsh:

5
setup.py
View file

@ -196,7 +196,10 @@ def restore_version():
class xinstall(install): class xinstall(install):
"""Xonsh specialization of setuptools install class.""" """Xonsh specialization of setuptools install class.
For production, let setuptools generate the
startup script, e.g: `pip installl .' rather than
relying on 'python setup.py install'."""
def run(self): def run(self):
clean_tables() clean_tables()