search

vesoft-inc / nebula-python

Client API of Nebula Graph in Python
193 stars 78 forks source link

Improve the installation instruction #152

Closed greyli closed 2 years ago

greyli commented 3 years ago

IMO, when installing the Python package from the source code, python setup.py install will install all the requirements defined in the install_requires argument of setup(), there is no need to use pip install -r requirements.txt. So I removed this redundant step in the installation instruction.

Besides, to install a Python from source, pip install . is preferred over python setup.py install since you can easily uninstall the package with the former way. So I use pip install . to replace the old command.

I also move the pip way to the first to follow the official docs (and this should be the recommended way to install Nebula-Python).

I will update the corresponding section in the Chinese/English docs if this PR got merged.

yihong0618 commented 3 years ago

IMO, when installing the Python package from the source code, python setup.py install will install all the requirements defined in the install_requires argument of setup(), there is no need to use pip install -r requirements.txt. So I removed this redundant step in the installation instruction.

Besides, to install a Python from source, pip install . is preferred over python setup.py install since you can easily uninstall the package with the former way. So I use pip install . to replace the old command.

I also move the pip way to the first to follow the official docs (and this should be the recommended way to install Nebula-Python).

I will update the corresponding section in the Chinese/English docs if this PR got merged

I think you can also change the install way in yml file. and do not delete the requirements.txt may better, because developer may also need some test to install requirements-dev.

greyli commented 3 years ago

I think you can also change the install way in yml file.

Which yml file?

and do not delete the requirements.txt may better, because developer may also need some test to install requirements-dev.

Sure, I didn't plan to delete them, these requirement files are normally for developers (but they need to be pinned, see #153 ).

yihong0618 commented 3 years ago

I think you can also change the install way in yml file.

Which yml file?

and do not delete the requirements.txt may better, because developer may also need some test to install requirements-dev.

Sure, I didn't plan to delete them, these requirement files are normally for developers (but they need to be pinned, see #153 ).

Cool got your point.