Skip to main content

openwisp-network-topology

https://travis-ci.org/openwisp/openwisp-network-topology.svg?branch=master https://coveralls.io/repos/github/openwisp/openwisp-network-topology/badge.svg Requirements Status https://badge.fury.io/py/openwisp-network-topology.svg

OpenWISP 2 network topology module (built using Python and Django web-framework).



Install stable version from pypi

Install from pypi:

pip install openwisp-network-topology

Install development version

Install tarball:

pip install https://github.com/openwisp/openwisp-network-topology/tarball/master

Alternatively you can install via pip using git:

pip install -e git+git://github.com/openwisp/openwisp-network-topology#egg=openwisp-network-topology

If you want to contribute, install your cloned fork:

git clone git@github.com:<your_fork>/openwisp-network-topology.git
cd openwisp-network-topology
python setup.py develop

Setup (integrate in an existing django project)

INSTALLED_APPS in settings.py should look like the following (order is important):

INSTALLED_APPS = [
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # for customized openwisp admin theme
    'openwisp_utils.admin_theme',
    # all-auth
    'django.contrib.sites',
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
    # openwisp2 modules
    'openwisp_network_topology',
    'openwisp_users',
    'rest_framework',
    # admin
    'django.contrib.admin',
]
EXTENDED_APPS = ('django_netjsongraph',)

Note that the EXTENDED_APPS may contain other names (if you installed other modules), in that case you should just add django_netjsongraph.

Add openwisp_utils.staticfiles.DependencyFinder to STATICFILES_FINDERS in your settings.py

STATICFILES_FINDERS = [
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    'openwisp_utils.staticfiles.DependencyFinder',
]

Add openwisp_utils.loaders.DependencyLoader to template loaders and openwisp_utils.admin_theme.context_processor.menu_items to context processors in the TEMPLATES setting of settings.py:

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'OPTIONS': {
            'loaders': [
                'django.template.loaders.filesystem.Loader',
                'django.template.loaders.app_directories.Loader',
                'openwisp_utils.loaders.DependencyLoader',
            ],
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
                'openwisp_utils.admin_theme.context_processor.menu_items'
            ],
        },
    }
]

Add the following settings to settings.py

LOGIN_REDIRECT_URL = 'admin:index'
ACCOUNT_LOGOUT_REDIRECT_URL = LOGIN_REDIRECT_URL

Add the URLs to your main urls.py:

from django.conf.urls import include, url
from django.contrib.staticfiles.urls import staticfiles_urlpatterns

from openwisp_utils.admin_theme.admin import admin, openwisp_admin

openwisp_admin()

urlpatterns = [
    url(r'^', include('openwisp_network_topology.urls')),
    url(r'^admin/', include(admin.site.urls)),
]

urlpatterns += staticfiles_urlpatterns()

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>/openwisp-network-topology
cd openwisp-network-topology/
python setup.py develop

Install test requirements:

pip install -r requirements-test.txt

Create database:

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

Set EMAIL_PORT in settings.py to a port number (eg: 1025):

EMAIL_PORT = '1025'

Launch development server and SMTP deubgging server:

./manage.py runserver
# open another session and run
python -m smtpd -n -c DebuggingServer localhost:1025

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

Run tests with:

./runtests.py

Run qa tests:

./run-qa-checks

Contributing

  1. Announce your intentions in the OpenWISP Mailing List and open relavant issues using the issue tracker

  2. Fork this repo and install the project following the instructions

  3. Follow PEP8, Style Guide for Python Code

  4. Write code and corresponding tests

  5. Ensure that all tests pass and the test coverage does not decrease

  6. Document your changes

  7. Send a pull request

Changelog

See CHANGES.

License

See LICENSE.

Support

See OpenWISP Support Channels.

Metadata

Release files for openwisp-network-topology 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openwisp-network-topology 0.3.2
File Size Uploaded Provenance Actions
openwisp-network-topology-0.3.2.tar.gz 16.5 kB Without provenance Details for openwisp-network-topology-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for openwisp-network-topology 0.3.2
File Interpreter ABI Platform Actions
openwisp_network_topology-0.3.2-py2.py3-none-any.whl Python 3, Python 2 none any Details for openwisp_network_topology-0.3.2-py2.py3-none-any.whl

Total release size: 40.6 kB

Release files / openwisp-network-topology-0.3.2.tar.gz

Download URL openwisp-network-topology-0.3.2.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b8d7077e2c5780d3104457b13bd15b83806874ccb3d6d351da8aea362505061f
BLAKE2b-256 checksum
How to use checksums
0c8ce516bb63df36f8f44f0e43f949b420d400b40bad25f6e57cdcfaa00f9309
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.3

Release files / openwisp_network_topology-0.3.2-py2.py3-none-any.whl

Download URL openwisp_network_topology-0.3.2-py2.py3-none-any.whl
Size 24.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2f371039f1627c65171cb7dea1db0b8ef0d8569309eba0c9e5db9e89ead8baf0
BLAKE2b-256 checksum
How to use checksums
7c7d14d04136bf3599485857f82086cd39ee8e9104728f498eeebe2e61b6a6bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.3

Security for openwisp-network-topology 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page