-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Point to existing install instructions #511
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
CONTRIBUTING.md
Outdated
@@ -2,7 +2,7 @@ | |||
|
|||
## Getting Started | |||
|
|||
Refer to the [readme](README.md) for installation and development instructions. | |||
Refer to the Dash User Guide for [installation](https://dash.plot.ly/installation) instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The installation instructions on the dash docs is for developing dash apps.
Installation for development on the dash repo should be:
- Create a virtualenv:
python -m venv venv
orvirtualenv venv
for python 2. - Activate the virtualenv:
. venv/bin/activate
orvenv\scripts\activate
for windows. - Install the dev dependencies:
pip install -r .circleci/requirements/dev-requirements.txt
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for reviewing, @T4rk1n! In light of your comment, I have submitted another change, which is more to the point. I don't think it is healthy to promote the use of Python 2 any more (I'll share references if you ask for them), so I have only included the Python 3 way.
CONTRIBUTING.md
Outdated
# Create a virtualenv (name it, say, dash-dev) | ||
python3 -m venv dash-dev | ||
# Activate this virtualenv | ||
. dash-dev/bin/activate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From these instructions it is not clear where the virtual environment will reside. Complete setup instruction should include:
$ git clone https://github.com/plotly/dash.git
$ cd dash
$ python -m venv venv
...
venv
name is normally used in the project directory, it is ignored in .gitignore
/.npmignore
of most projects. I only name my environments when I work multi-repo and I put it in another folder.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! I can see venv
in the .gitignore
file; I wasn't aware of this convention; I used to keep all my virtualenvs under ~/.virtualenv/
(calling for prior command mkdir -p ~/.virtualenv/
as in http://nipy.org/nipy/devel/tools/virtualenv-tutor.html).
Lately, I have used almost only conda environments, following the wave in the SciPy/PyData community, so thanks for the refresher! I'll make and push the change right now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@T4rk1n hmm, in the general case, newcomers willing to contribute would have to fork the repo first... I'll replace the first command with a generic comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not to mention that some people (including me) would clone over SSH ;)
Voilà, @T4rk1n! I have used your convention of prefixing commands with |
Looking good, thanks 💃 |
…ate-callback Issue 510 fix clearing date callback
Hello @plotly/dash @rmarren1 and @T4rk1n!
I'm trying to document the installation of dash-bio, so I came here for inspiration! In the current version of the README, there are no installation (let alone development) instructions. That's why I'm suggesting pointing to the user guide.