django-freeradius 0.1.alpha

Django reusable app that provides an admin interface to a freeradius database

---

TODO:

---

Table of Contents:

• Current features

• Project goals

• Install stable version from pypi

• Install development version

• Setup (integrate in an existing django project)

• Installing for development

• Settings

• Extending django-freeradius

  • Extending models

  • Extending the admin

• Contributing

• Changelog

• License

• Support

---

Current features

• TODO

Project goals

• TODO

Install stable version from pypi

Install from pypi:

pip install django-freeradius

Install development version

Install tarball:

pip install https://github.com/openwisp/django-freeradius/tarball/master

Alternatively you can install via pip using git:

pip install -e git+git://github.com/openwisp/django-freeradius#egg=django-freeradius

If you want to contribute, install your cloned fork:

git clone [e-mail]:<your_fork>/django-freeradius.git
cd django-freeradius
python setup.py develop

Setup (integrate in an existing django project)

Add django_freeradius to INSTALLED_APPS:

INSTALLED_APPS = [
    # other apps
    'django_freeradius',
]

Add the URLs to your main urls.py:

urlpatterns = [
    # ... other urls in your project ...

    # django-freeradius urls
    # keep the namespace argument unchanged
    url(r'^', include('django_freeradius.urls', namespace='freeradius')),
]

Then run:

./manage.py migrate

Installing for development

Install sqlite:

sudo apt-get install sqlite3 libsqlite3-dev

Install your forked repo:

git clone git://github.com/<your_fork>/django-freeradius
cd django-freeradius/
python setup.py develop

Install test requirements:

pip install -r requirements-test.txt

Create database:

cd tests/
./manage.py migrate
./manage.py createsuperuser

Launch development server:

./manage.py runserver

You can access the admin interface at http://127.0.0.1:8000/admin/.

Run tests with:

./runtests.py

Settings

TODO

Extending django-freeradius

django-freeradius provides a set of models and admin classes which can be imported, extended and reused by third party apps.

To extend django-freeradius, you MUST NOT add it to settings.INSTALLED_APPS, but you must create your own app (which goes into settings.INSTALLED_APPS), import the base classes from django-freeradius and add your customizations.

Extending models

This example provides an example of how to extend the base models of django-freeradius by adding a relation to another django model named Organization.

# TODO

Extending the admin

Following the previous Organization example, you can avoid duplicating the admin code by importing the base admin classes and registering your models with.

# TODO

Contributing

1. Announce your intentions in the OpenWISP Mailing List

2. Fork this repo and install it

3. Follow PEP8, Style Guide for Python Code

4. Write code

5. Write tests for your code

6. Ensure all tests pass

7. Ensure test coverage does not decrease

8. Document your changes

9. Send pull request

Changelog

See CHANGES.

License

See LICENSE.

Support

See OpenWISP Support Channels.