Developing cg-django-uaa¶
Important
This section is about developing cg-django-uaa itself, not using it in your Django project. For details on the latter, see the Quick start guide.
First, clone the git repository:
git clone https://github.com/18F/cg-django-uaa
Then create a virtualenv for the project and install development dependencies:
virtualenv -p python3 venv
source venv/bin/activate
pip install -r requirements-dev.txt
Then install cg-django-uaa in development mode:
python setup.py develop
Using the example app¶
An example Django project provides a trivial integration with cg-django-uaa and can be used to manually ensure that everything works as expected.
To use it, run the following from the root of the repository:
cd example
python manage.py migrate
python manage.py createsuperuser --username foo --email foo@example.org --noinput
python manage.py runserver
At this point you should be able to visit the locally-hosted project and login to fake cloud.gov as foo@example.org.
If you’d like to modify any of the example app’s settings, you can
do so by creating an example/example/settings_local.py
file;
any settings defined there will override the ones in
example/example/settings.py
.
Running tests¶
You can run all the tests with code coverage and linting:
python setup.py ultratest
Note that this command will fail if any tests do not pass, if there are any linting warnings, or if code coverage is not at 100%.
Writing documentation¶
If you want to work on documentation, you can run the development documentation server with:
python setup.py devdocs