DOC: Add development installation instructions #64
Conversation
Codecov Report
@@ Coverage Diff @@
## master #64 +/- ##
==========================================
- Coverage 73.44% 28.24% -45.2%
==========================================
Files 4 4
Lines 1540 1540
==========================================
- Hits 1131 435 -696
- Misses 409 1105 +696
Continue to review full report at Codecov.
|
docs/source/install.rst
Outdated
| ~~~~~ | ||
|
|
||
| To install packages in development mode using conda, first | ||
| install the conda build tools package in your root conda environment. |
There was a problem hiding this comment.
this is duplicating some of contributing.rst
you can move there
There was a problem hiding this comment.
I've moved these instructions all to contributing.rst.
docs/source/install.rst
Outdated
| @@ -32,6 +32,60 @@ Install from Source | |||
| $ pip install git+https://github.com/pydata/pandas-gbq.git | |||
There was a problem hiding this comment.
i would remove the build some source section (or u can leave the header and just point to contributing.rst)
docs/source/install.rst
Outdated
|
|
||
| .. code-block:: shell | ||
|
|
||
| $ conda install --channel conda-forge \ |
There was a problem hiding this comment.
so the point of this is you don't have to specify secondary deps, they will simply be installed via the dependency graph. it looks like you install
conda create -n foo --dry google-auth-oauthlib google-api-python-client pandas google-auth-httplib2
though I am suprised that google-auth is actually a dep of the google-auth-oauthlib (and httplib2), you usually don't do it this way, rather installing google-auth should install all libs under its tree, so this is a bit odd.
docs/source/install.rst
Outdated
|
|
||
| .. code-block:: shell | ||
|
|
||
| $ conda develop . |
There was a problem hiding this comment.
we use python setup.py develop rather than conda develop
docs/source/install.rst
Outdated
|
|
||
| .. code-block:: shell | ||
|
|
||
| $ conda create --no-deps -n pandas-gbq |
There was a problem hiding this comment.
you can do this all in one go, see below
docs/source/install.rst
Outdated
|
|
||
| .. code-block:: shell | ||
|
|
||
| $ conda install conda-build |
docs/source/install.rst
Outdated
|
|
||
| $ conda install conda-build | ||
|
|
||
| Optionally, create a new conda environment. |
There was a problem hiding this comment.
this is not optional, you always do this.
docs/source/install.rst
Outdated
|
|
||
| .. code-block:: shell | ||
|
|
||
| $ pip install -e . |
There was a problem hiding this comment.
we generally don't use pip to install things when we have proper conda packages. sure you can, but its not the first thing you do.
There was a problem hiding this comment.
You're right.
I'd like to keep these instructions for folks that aren't using conda. I've moved the section after and added a disclaimer that it's not necessary if using conda.
9b622e3 to
40c4333
Compare
Includes conda install steps for dependencies.
|
yeah see #20 about the coverage issue. Maybe need to skip the user checks for this. |
Includes conda install steps for dependencies.
Closes #63.