Skip to content

Commit 2594f16

Browse files
authored
Merge pull request #145 from sympy/nitpicks
Update README test/deploy instructions
2 parents f8637ea + f99634e commit 2594f16

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ my/
3333

3434
# IntelliJ/Jetbrains
3535
.idea
36+
37+
# Credentials
38+
client-secret.json
39+
40+
# app engine lib
41+
lib

README.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,15 @@ This is a local server that runs on port 8080 (use ``--port`` option to
8383
change this). Open a web browser and go to http://localhost:8080. You
8484
should see GUI of SymPy Gamma.
8585

86-
Uploading to GAE (Manually)
87-
---------------------------
86+
Deploying to GAE
87+
----------------
8888

89-
Travis-CI is used to deploy automatically to the official server. To upload
90-
the application manually, you need to do a few things. First, tag the
89+
Travis-CI is used to deploy automatically to the official server via Github Releases.
90+
Go to https://github.com/sympy/sympy_gamma/releases and click on create a release and
91+
name the release as version-NN where NN is the release version. After this travis will
92+
automatically release the version NN.
93+
94+
To upload the application manually, you need to do a few things. First, tag the
9195
current commit with the App Engine application version (this is not
9296
necessary unless you are deploying to the official server)::
9397

@@ -119,6 +123,7 @@ the ``Versions`` section of the sympy_gamma dashboard, and set this as the
119123
new default version. If there are any issues, you can roll back to the
120124
previous version from this same screen.
121125

126+
122127
Creating Deployment Credentials
123128
-------------------------------
124129

@@ -159,8 +164,8 @@ pull request, so that others can easily review your work, without even having
159164
to use ``dev_appserver.py``.
160165

161166
Branch builds are automatically deployed by Travis to
162-
`https://N-dot-sympy-gamma-tests.appspot.com/`, where `N` is the branch name.
163-
Note that the pull request has to from a branch on this repository, as
167+
`https://<BRANCH-NAME>-dot-sympy-gamma-hrd.appspot.com/`.
168+
Note that the pull request has to be from a branch on this repository, as
164169
forks do not have access to the key to deploy to the app engine.
165170

166171
Development notes
@@ -198,6 +203,8 @@ To be able to run tests, make sure you have testing libraries installed::
198203
npm install -g casperjs
199204
pip install nose
200205

206+
Install phantomjs for your system from: https://phantomjs.org/download.html
207+
201208
To run unit tests::
202209

203210
PYTHONPATH='.' nosetests app/test -vv

0 commit comments

Comments
 (0)