django-owm-legacy
=================
.. image:: https://github.com/openwisp/django-owm-legacy/workflows/Django%20OWM%20Legacy%20CI%20Build/badge.svg?branch=master
:target: https://github.com/openwisp/django-owm-legacy/actions?query=workflow%3A"Django%20OWM%20Legacy%20CI%20Build"
:alt: CI build status
.. image:: https://coveralls.io/repos/openwisp/django-owm-legacy/badge.svg
:target: https://coveralls.io/r/openwisp/django-owm-legacy
:alt: Test Coverage
.. image:: https://img.shields.io/librariesio/release/github/openwisp/django-owm-legacy
:target: https://libraries.io/github/openwisp/django-owm-legacy#repository_dependencies
:alt: Dependency monitoring
.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg
:target: https://gitter.im/openwisp/general
:alt: Chat
.. image:: https://badge.fury.io/py/django-owm-legacy.svg
:target: http://badge.fury.io/py/django-owm-legacy
.. image:: https://pepy.tech/badge/django-owm-legacy
:target: https://pepy.tech/project/django-owm-legacy
:alt: Downloads
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://pypi.org/project/black/
:alt: code style: black
----
Legacy features of OpenWISP Manager reimplemented in django for `OpenWISP2
<https://github.com/openwisp/ansible-openwisp2>`_.
Install stable version from pypi
--------------------------------
Install from pypi:
.. code-block:: shell
pip install django-owm-legacy
Install development version
---------------------------
Install tarball:
.. code-block:: shell
pip install https://github.com/openwisp/django-owm-legacy/tarball/master
Alternatively you can install via pip using git:
.. code-block:: shell
pip install -e git+git://github.com/openwisp/django-owm-legacy#egg=django-owm-legacy
If you want to contribute, install your cloned fork:
.. code-block:: shell
git clone git@github.com:<your_fork>/django-owm-legacy.git
cd django-owm-legacy
python setup.py develop
Setup (integrate in an existing django project)
-----------------------------------------------
Add ``openwisp_controller`` and ``owm_legacy`` to ``INSTALLED_APPS`` as
follow:
.. code-block:: python
INSTALLED_APPS = [
# ...
"django.contrib.sites",
# allauth
"allauth",
"allauth.account",
"django_extensions",
# openwisp2 modules
"openwisp_controller.config",
"openwisp_controller.pki",
"openwisp_controller.geo",
"openwisp_controller.connection",
"openwisp_users",
"openwisp_notifications",
"openwisp_ipam",
# openwisp2 admin theme
# (must be loaded here)
"openwisp_utils.admin_theme",
"django.contrib.admin",
"django.forms",
# other dependencies
"sortedm2m",
"reversion",
"leaflet",
"flat_json_widget",
"owm_legacy",
# ...
]
Other settings needed in ``settings.py``:
.. code-block:: python
EXTENDED_APPS = ("django_x509", "django_loci")
AUTH_USER_MODEL = "openwisp_users.User"
SITE_ID = 1
Your ``urls.py`` should look like the following:
.. code-block:: python
from django.urls import include, path
from django.contrib import admin
from django.contrib.staticfiles.urls import staticfiles_urlpatterns
admin.autodiscover()
urlpatterns = [
path("admin/", include(admin.site.urls)),
path("", include("openwisp_controller.urls", namespace="controller")),
path("", include("owm_legacy.urls", namespace="owm_legacy")),
]
urlpatterns += staticfiles_urlpatterns()
Installing for development
--------------------------
Install sqlite:
.. code-block:: shell
sudo apt install -y sqlite3 libsqlite3-dev openssl libssl-dev
sudo apt install -y gdal-bin libproj-dev libgeos-dev libspatialite-dev libsqlite3-mod-spatialite
Launch Redis:
.. code-block:: shell
docker-compose up -d redis
Install your forked repo:
.. code-block:: shell
git clone git://github.com/<your_fork>/django-owm-legacy
cd django-owm-legacy/
python setup.py develop
Install test requirements:
.. code-block:: shell
pip install -r requirements-test.txt
Create database:
.. code-block:: shell
cd tests/
./manage.py migrate
./manage.py createsuperuser
Launch celery worker (for background jobs):
.. code-block:: shell
celery -A openwisp2 worker -l info
Launch development server:
.. code-block:: shell
./manage.py runserver
You can access the admin interface at http://127.0.0.1:8000/admin/.
Run tests with:
.. code-block:: shell
./runtests.py
Settings
--------
``OWM_LEGACY_ALLOWED_SUBNETS``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
============ ===================================
**type**: ``list``
**default**: ``['10.8.0.0/16', '127.0.0.1/32']``
============ ===================================
List of strings representing ip networks allowed to retrieve checksums and
download configuration archives.
Contributing
------------
Please refer to the `OpenWISP contributing guidelines
<http://openwisp.io/docs/developer/contributing.html>`_.
.. _pep8, style guide for python code: http://www.python.org/dev/peps/pep-0008/
Changelog
---------
See `CHANGES
<https://github.com/openwisp/django-owm-legacy/blob/master/CHANGES.rst>`_.
License
-------
See `LICENSE
<https://github.com/openwisp/django-owm-legacy/blob/master/LICENSE>`_.
Support
-------
See `OpenWISP Support Channels <http://openwisp.org/support.html>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/openwisp/django-owm-legacy",
"name": "django-owm-legacy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django, openwisp, openwrt, networking",
"author": "Federico Capoano",
"author_email": "support@openwisp.io",
"download_url": "https://files.pythonhosted.org/packages/9a/9b/5f5be461734b24413bf89e2252a582a54eefa66c0f6b8c8daf4c7e921999/django_owm_legacy-1.1.tar.gz",
"platform": "Platform Indipendent",
"description": "django-owm-legacy\n=================\n\n.. image:: https://github.com/openwisp/django-owm-legacy/workflows/Django%20OWM%20Legacy%20CI%20Build/badge.svg?branch=master\n :target: https://github.com/openwisp/django-owm-legacy/actions?query=workflow%3A\"Django%20OWM%20Legacy%20CI%20Build\"\n :alt: CI build status\n\n.. image:: https://coveralls.io/repos/openwisp/django-owm-legacy/badge.svg\n :target: https://coveralls.io/r/openwisp/django-owm-legacy\n :alt: Test Coverage\n\n.. image:: https://img.shields.io/librariesio/release/github/openwisp/django-owm-legacy\n :target: https://libraries.io/github/openwisp/django-owm-legacy#repository_dependencies\n :alt: Dependency monitoring\n\n.. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg\n :target: https://gitter.im/openwisp/general\n :alt: Chat\n\n.. image:: https://badge.fury.io/py/django-owm-legacy.svg\n :target: http://badge.fury.io/py/django-owm-legacy\n\n.. image:: https://pepy.tech/badge/django-owm-legacy\n :target: https://pepy.tech/project/django-owm-legacy\n :alt: Downloads\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://pypi.org/project/black/\n :alt: code style: black\n\n----\n\nLegacy features of OpenWISP Manager reimplemented in django for `OpenWISP2\n<https://github.com/openwisp/ansible-openwisp2>`_.\n\nInstall stable version from pypi\n--------------------------------\n\nInstall from pypi:\n\n.. code-block:: shell\n\n pip install django-owm-legacy\n\nInstall development version\n---------------------------\n\nInstall tarball:\n\n.. code-block:: shell\n\n pip install https://github.com/openwisp/django-owm-legacy/tarball/master\n\nAlternatively you can install via pip using git:\n\n.. code-block:: shell\n\n pip install -e git+git://github.com/openwisp/django-owm-legacy#egg=django-owm-legacy\n\nIf you want to contribute, install your cloned fork:\n\n.. code-block:: shell\n\n git clone git@github.com:<your_fork>/django-owm-legacy.git\n cd django-owm-legacy\n python setup.py develop\n\nSetup (integrate in an existing django project)\n-----------------------------------------------\n\nAdd ``openwisp_controller`` and ``owm_legacy`` to ``INSTALLED_APPS`` as\nfollow:\n\n.. code-block:: python\n\n INSTALLED_APPS = [\n # ...\n \"django.contrib.sites\",\n # allauth\n \"allauth\",\n \"allauth.account\",\n \"django_extensions\",\n # openwisp2 modules\n \"openwisp_controller.config\",\n \"openwisp_controller.pki\",\n \"openwisp_controller.geo\",\n \"openwisp_controller.connection\",\n \"openwisp_users\",\n \"openwisp_notifications\",\n \"openwisp_ipam\",\n # openwisp2 admin theme\n # (must be loaded here)\n \"openwisp_utils.admin_theme\",\n \"django.contrib.admin\",\n \"django.forms\",\n # other dependencies\n \"sortedm2m\",\n \"reversion\",\n \"leaflet\",\n \"flat_json_widget\",\n \"owm_legacy\",\n # ...\n ]\n\nOther settings needed in ``settings.py``:\n\n.. code-block:: python\n\n EXTENDED_APPS = (\"django_x509\", \"django_loci\")\n\n AUTH_USER_MODEL = \"openwisp_users.User\"\n SITE_ID = 1\n\nYour ``urls.py`` should look like the following:\n\n.. code-block:: python\n\n from django.urls import include, path\n from django.contrib import admin\n from django.contrib.staticfiles.urls import staticfiles_urlpatterns\n\n admin.autodiscover()\n\n\n urlpatterns = [\n path(\"admin/\", include(admin.site.urls)),\n path(\"\", include(\"openwisp_controller.urls\", namespace=\"controller\")),\n path(\"\", include(\"owm_legacy.urls\", namespace=\"owm_legacy\")),\n ]\n\n urlpatterns += staticfiles_urlpatterns()\n\nInstalling for development\n--------------------------\n\nInstall sqlite:\n\n.. code-block:: shell\n\n sudo apt install -y sqlite3 libsqlite3-dev openssl libssl-dev\n sudo apt install -y gdal-bin libproj-dev libgeos-dev libspatialite-dev libsqlite3-mod-spatialite\n\nLaunch Redis:\n\n.. code-block:: shell\n\n docker-compose up -d redis\n\nInstall your forked repo:\n\n.. code-block:: shell\n\n git clone git://github.com/<your_fork>/django-owm-legacy\n cd django-owm-legacy/\n python setup.py develop\n\nInstall test requirements:\n\n.. code-block:: shell\n\n pip install -r requirements-test.txt\n\nCreate database:\n\n.. code-block:: shell\n\n cd tests/\n ./manage.py migrate\n ./manage.py createsuperuser\n\nLaunch celery worker (for background jobs):\n\n.. code-block:: shell\n\n celery -A openwisp2 worker -l info\n\nLaunch development server:\n\n.. code-block:: shell\n\n ./manage.py runserver\n\nYou can access the admin interface at http://127.0.0.1:8000/admin/.\n\nRun tests with:\n\n.. code-block:: shell\n\n ./runtests.py\n\nSettings\n--------\n\n``OWM_LEGACY_ALLOWED_SUBNETS``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n============ ===================================\n**type**: ``list``\n**default**: ``['10.8.0.0/16', '127.0.0.1/32']``\n============ ===================================\n\nList of strings representing ip networks allowed to retrieve checksums and\ndownload configuration archives.\n\nContributing\n------------\n\nPlease refer to the `OpenWISP contributing guidelines\n<http://openwisp.io/docs/developer/contributing.html>`_.\n\n.. _pep8, style guide for python code: http://www.python.org/dev/peps/pep-0008/\n\nChangelog\n---------\n\nSee `CHANGES\n<https://github.com/openwisp/django-owm-legacy/blob/master/CHANGES.rst>`_.\n\nLicense\n-------\n\nSee `LICENSE\n<https://github.com/openwisp/django-owm-legacy/blob/master/LICENSE>`_.\n\nSupport\n-------\n\nSee `OpenWISP Support Channels <http://openwisp.org/support.html>`_.\n",
"bugtrack_url": null,
"license": "GPL3",
"summary": "Legacy features of OpenWISP Manager reimplemented in django",
"version": "1.1",
"project_urls": {
"Download": "https://github.com/openwisp/django-owm-legacy/releases",
"Homepage": "https://github.com/openwisp/django-owm-legacy"
},
"split_keywords": [
"django",
" openwisp",
" openwrt",
" networking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07f0bf4d3b4c888cda15c2e11e3057a10e0e579452f7b65ca65202709c84333d",
"md5": "8ffc98c0f365431b606cc390a335603a",
"sha256": "38686c9be932b4e9bd9606b878c1cdb75365eb35ce4a87368cfe6512b7882a79"
},
"downloads": -1,
"filename": "django_owm_legacy-1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8ffc98c0f365431b606cc390a335603a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 19703,
"upload_time": "2024-11-29T21:07:06",
"upload_time_iso_8601": "2024-11-29T21:07:06.734630Z",
"url": "https://files.pythonhosted.org/packages/07/f0/bf4d3b4c888cda15c2e11e3057a10e0e579452f7b65ca65202709c84333d/django_owm_legacy-1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a9b5f5be461734b24413bf89e2252a582a54eefa66c0f6b8c8daf4c7e921999",
"md5": "5161e75e2851c9a1f8936acc07f37ca8",
"sha256": "dfc017ca92d463632dd8bbd9034f6624fba5aa56c42c99c23ac5984389d62307"
},
"downloads": -1,
"filename": "django_owm_legacy-1.1.tar.gz",
"has_sig": false,
"md5_digest": "5161e75e2851c9a1f8936acc07f37ca8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20086,
"upload_time": "2024-11-29T21:07:33",
"upload_time_iso_8601": "2024-11-29T21:07:33.604148Z",
"url": "https://files.pythonhosted.org/packages/9a/9b/5f5be461734b24413bf89e2252a582a54eefa66c0f6b8c8daf4c7e921999/django_owm_legacy-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-29 21:07:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openwisp",
"github_project": "django-owm-legacy",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "django-owm-legacy"
}
JSON
