Skip to main content

Utility collection of Django package

Project description

This is a utility collection for packaging Django App. The following features are available.

  1. Unittest utility for running with setup.py

  2. Unittest utility for dynamically adding models only used in the test

  3. Automatically create user within syncdb command

How to install

Use pip comand or easy_install:

pip install django-packageutils

Directory tree assumed

django-packagename
    +- setup.py
    +- RELEASE-VERSION          # used for git versioning
    +- packagename              # your package
        +- __init__.py
        +- models.py            # or whatever
        +- tests
            +- __init__.py
            +- test_models.py   # or whatever
            +- testapp          # App only required in tests of this package
                +- __init__.py
                +- models.py
    +- test                     # django project for testing
        +- __init__.py
        +- settings.py
        +- manage.py
        +- urls.py
        +- runtests.py          # for running test with setup.py

Unittest utility for running with setup.py

Write your runtests.py in your package directory as:

import os
from packageutils.test import get_package_runner
from packageutils.test import run_tests

def runtests(verbosity=1, interactive=True):
    package_dir = os.path.dirname(__file__)
    test_runner = get_package_runner(package_dir, verbosity, interactive)
    run_tests(test_runner, ['some_application_name'])

if __name__ == '__main__':
    runtests()

Add test suite to your setup.py as:

setup(
    # ... some configures
    install_requires = [
        'distribute',           # recommended
        'setuptools-git',       # recommended
        'django-packageutils',  # required
        # and some other requires
    ],
    test_suite = 'tests.runtests.runtests',
    test_require = [
        'django',
    ],
)

Then execute the following command:

python setup.py test

Unittest utility for dynamically adding models only used in the test

With Django default TestCase, you cannot add required models within test. Sometime you need extra models for testing your django package then you can use AppTestCase as:

from packageutils.testcase import AppTestCase
from testapp.models import Article

class TestAppTestCase(AppTestCase):
    # Apps only required in this test
    installed_apps = [
        'packagename.tests.testapp',
    ]
    # Middlewares only required in this test
    middleware_classes = [
        'testapp.middleware.SomeMiddlewareRequired',
    ]

    def test_creation(self):
        article = Article.objects.create(title='foo')
        assert Article.objects.filter(title='foo').exists()

Automatically create user within syncdb command

Add packageutils.syncdb.autouser in INSTALLED_APPS then admin user is created automatically within syncdb command (password will be set as ‘admin’)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-packageutils-0.1.0.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

django_packageutils-0.1.0-py2.7.egg (60.1 kB view details)

Uploaded Source

File details

Details for the file django-packageutils-0.1.0.tar.gz.

File metadata

File hashes

Hashes for django-packageutils-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e067b3c8954d5550c5c69dd27e795259ac2f67e570bdfab5f03d7ab716db1be6
MD5 65c4063bd7220612ae373456caaf6d09
BLAKE2b-256 c1a13ac729fd1f409ec3d7730bf7f7c79b6a91b6caac7e35743cf40770803d00

See more details on using hashes here.

File details

Details for the file django_packageutils-0.1.0-py2.7.egg.

File metadata

File hashes

Hashes for django_packageutils-0.1.0-py2.7.egg
Algorithm Hash digest
SHA256 7eed53f5806ca193b586d031579f5cc2667dfca2ef94b9c677f953943a5d2bae
MD5 959b3768d94654b917d53ce00731060c
BLAKE2b-256 97f1e4aa0b9e3d93da23fe9ab33a91eb94f325649b55a71779cdbb41c8d9c8c9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page