Skip to content

AditiSah05/openwisp-utils

 
 

Repository files navigation

openwisp-utils

CI build status Test coverage Dependency monitoring pypi downloads support chat code style: black

Python and Django functions, classes and settings re-used across different OpenWISP modules, stored here with the aim of avoiding code duplication and ease maintenance.

Don't repeat yourself!

Documentation
WOFF files extracted using https://github.com/majodev/google-webfonts-helper.

Running tests locally (Windows PowerShell)

If you're on Windows, the included helper script will create a virtualenv, install deps and run tests.

From the repository root:

`powershell .\run-tests.ps1 `

Alternatively, do the steps manually:

```powershell # Create and activate venv python -m venv .venv Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass . ..venvScriptsActivate.ps1

# Install package pip install -e .[rest,qa]

# Install test requirements pip install -r requirements-test.txt

# Run tests python runtests.py ```

Notes:

  • The requirements-test.txt installs openwisp_controller from the GitHub master tarball. This may take a while and can fail on very new Python versions.
  • If you hit a ModuleNotFoundError (for example openwisp_controller), try installing the tarball manually:

`powershell pip install "openwisp_controller @ https://github.com/openwisp/openwisp-controller/tarball/master" `

If you want help running the tests or a CI setup, open an issue with the test failure output and your environment info.
<https://openwisp.io/docs/stable/utils/developer/>`_

Contributing

Please refer to the OpenWISP contributing guidelines.

Support

See OpenWISP Support Channels.

Changelog

See CHANGES.

License

See LICENSE.

Attribution

About

Python and Django utilities shared between different openwisp modules

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 74.7%
  • CSS 11.7%
  • JavaScript 6.1%
  • HTML 5.9%
  • Shell 1.6%