Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update local execution instructions. #119

Merged
merged 1 commit into from
Jun 2, 2017
Merged

Update local execution instructions. #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,38 @@ https://github.com/modilabs/pyxform

pyxform is a major rewrite of `xls2xform <http://github.com/mvpdev/xls2xform/>`_.

Running pyxform as a Python script:
===========================
Running pyxform from local source
=================================

1. install xlrd::
Note that you must uninstall any globally installed `pyxform` instance in order to use local modules.

# On ubuntu these terminal commands should do it:
From the command line::

easy_install pip
python setup.py develop
python pyxform/xls2xform.py path_to_XLSForm output_path

pip install xlrd
Consider using a `virtualenv <http://python-guide-pt-br.readthedocs.io/en/latest/dev/virtualenvs/>`_ and `virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/en/latest/>`_ to make dependency management easier and keep your global site-packages directory clean::

2. Run this command::
pip install virtualenv
pip install virtualenvwrapper
mkvirtualenv local_pyxform # or whatever you want to name it
(local_pyxform)$ python setup.py develop # install the local files
(local_pyxform)$ python pyxform/xls2xform.py --help
(local_pyxform)$ xls2xform --help # same effect as previous line
(local_pyxform)$ which xls2xform. # ~/.virtualenvs/local_pyxform/bin/xls2xform

python pyxform/xls2xform.py path_to_XLSForm output_path
To leave and return to the virtual environment::

Installation
============
Installing pyxform from github is easy with pip::
(local_pyxform)$ deactivate # leave the virtualenv
$ xls2xform --help
# -bash: xls2xform: command not found
$ workon local_pyxform # reactivate the virtualenv
(local_pyxform)$ which xls2xform # & we can access the scripts once again
~/.virtualenvs/local_pyxform/bin/xls2xform

Installing pyxform from remote source
=====================================
`pip` can install from any GitHub repository::

pip install -e git+https://github.com/INSERT GH USER NAME HERE/pyxform.git@master#egg=pyxform

Expand Down