-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Getting started/installation guide. Fixes #1
- Loading branch information
Mark Lavin
committed
Feb 7, 2013
1 parent
6bc3857
commit 4f348f4
Showing
2 changed files
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,6 +12,7 @@ Contents | |
:maxdepth: 2 | ||
|
||
overview | ||
quick-start | ||
usage | ||
backends | ||
settings | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
Getting Started | ||
==================================== | ||
|
||
Here you will find the necessary steps to install and initial configure the | ||
rapidsms-healthcare application. | ||
|
||
|
||
Requirements | ||
------------------------------------ | ||
|
||
rapidsms-healthcare requires Python 2.6 or 2.7. Python 3 is not currently supported but is | ||
planned in the future as Django and RapidSMS support for Python 3 increases. It also requires | ||
the following packages: | ||
|
||
* Django >= 1.4 | ||
* RapidSMS >= 0.11.0 | ||
|
||
|
||
Installation | ||
------------------------------------ | ||
|
||
Stable releases of rapidsms-healthcare can be found on `PyPi <http://pypi.python.org/>`_ | ||
and `pip <http://www.pip-installer.org/>`_ is the recommended method for installing the package:: | ||
|
||
pip install rapidsms-healthcare | ||
|
||
|
||
Configuration | ||
------------------------------------ | ||
|
||
The storage and retrieval of healthcare related data is configured by the :ref:`HEALTHCARE_STORAGE_BACKEND` setting. | ||
If you are using the default storage backend you need to change your ``INSTALLED_APPS`` to include:: | ||
|
||
INSTALLED_APPS = ( | ||
# Other apps go here | ||
'healthcare.backends.django', | ||
) | ||
|
||
If you are using a different backend then you can skip this step. | ||
|
||
|
||
Next Steps | ||
------------------------------------ | ||
|
||
* For information on storing and retrieving data you can go to the :doc:`usage documentation </usage>`. | ||
* For information on creating a custom storage backend please see the :doc:`backend API documentation </backends>`. | ||
* If you have found and bug or would like to contribute a feature you can go to the :doc:`contributing guide </contributing>`. |