├── .github ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE │ ├── bug_report.md │ ├── feature_request.md │ └── question.md ├── STYLE_GUIDE.md └── workflows │ ├── bandit.yaml │ ├── black.yaml │ ├── coveralls.yaml │ ├── isort.yaml │ ├── mypy.yaml │ ├── pypi.yaml │ ├── pytest.yaml │ ├── radon.yaml │ ├── ruff.yaml │ ├── safety.yaml │ └── tox.yaml ├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── docs ├── .readthedocs.yaml ├── Makefile ├── django_settings.py ├── make.bat └── source │ ├── about.md │ ├── coc.md │ ├── conf.py │ ├── contributing.md │ ├── features.md │ ├── images │ ├── pyg_chart.png │ └── pyg_upload.png │ ├── index.md │ ├── installation.md │ ├── internals.md │ ├── license.md │ ├── style_guide.md │ └── version_history.md ├── pyproject.toml ├── src ├── __init__.py └── djangoaddicts │ ├── __init__.py │ └── pygwalker │ ├── __init__.py │ ├── apps.py │ ├── forms.py │ ├── templates │ └── pygwalker │ │ └── bs5 │ │ ├── partials │ │ ├── file_upload.htm │ │ ├── footer.htm │ │ ├── header.htm │ │ ├── pyg.htm │ │ └── pygwalker_nav_menu.htm │ │ ├── pygwalker.html │ │ └── pygwalker_dynamic.html │ ├── urls.py │ └── views.py └── tests ├── __init__.py ├── core ├── __init__.py ├── settings.py ├── templates │ └── base.htm ├── testapp │ ├── __init__.py │ ├── apps.py │ ├── forms.py │ ├── migrations │ │ ├── 0001_initial.py │ │ └── __init__.py │ ├── models.py │ ├── templates │ │ └── testapp │ │ │ └── my_custom_template.html │ └── views.py └── urls.py ├── data ├── blank ├── data.csv └── invalid └── unit ├── __init__.py └── test_views.py /.github/CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 2 | # Contributor Code of Conduct 3 | 4 | As contributors and maintainers of this project, and in the interest of 5 | fostering an open and welcoming community, we pledge to respect all people who 6 | contribute through reporting issues, posting feature requests, updating 7 | documentation, submitting pull requests or patches, and other activities. 8 | 9 | We are committed to making participation in this project a harassment-free 10 | experience for everyone, regardless of level of experience, gender, gender 11 | identity and expression, sexual orientation, disability, personal appearance, 12 | body size, race, ethnicity, age, religion, or nationality. 13 | 14 | Examples of unacceptable behavior by participants include: 15 | 16 | * The use of sexualized language or imagery 17 | * Personal attacks 18 | * Trolling or insulting/derogatory comments 19 | * Public or private harassment 20 | * Publishing other's private information, such as physical or electronic 21 | addresses, without explicit permission 22 | * Other unethical or unprofessional conduct 23 | 24 | Project maintainers have the right and responsibility to remove, edit, or 25 | reject comments, commits, code, wiki edits, issues, and other contributions 26 | that are not aligned to this Code of Conduct, or to ban temporarily or 27 | permanently any contributor for other behaviors that they deem inappropriate, 28 | threatening, offensive, or harmful. 29 | 30 | By adopting this Code of Conduct, project maintainers commit themselves to 31 | fairly and consistently applying these principles to every aspect of managing 32 | this project. Project maintainers who do not follow or enforce the Code of 33 | Conduct may be permanently removed from the project team. 34 | 35 | This Code of Conduct applies both within project spaces and in public spaces 36 | when an individual is representing the project or its community. 37 | 38 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 39 | reported by contacting a project maintainer at info@djangoaddicts.com. All 40 | complaints will be reviewed and investigated and will result in a response that 41 | is deemed necessary and appropriate to the circumstances. Maintainers are 42 | obligated to maintain confidentiality with regard to the reporter of an 43 | incident. 44 | 45 | 46 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 47 | version 1.3.0, available at https://www.contributor-covenant.org/version/1/3/0/code-of-conduct.html 48 | 49 | [homepage]: https://www.contributor-covenant.org 50 | -------------------------------------------------------------------------------- /.github/CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to django-pygwalker 2 | 3 | First off, thank you for considering contributing to django-pygwalker! 4 | 5 | The following is a set of guidelines for contributing to this project. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. 6 | 7 | ## Table of Contents 8 | 9 | 1. [Code of Conduct](#code-of-conduct) 10 | 2. [How Can I Contribute?](#how-can-i-contribute) 11 | - [Reporting Bugs](#reporting-bugs) 12 | - [Suggesting Enhancements](#suggesting-enhancements) 13 | - [Pull Requests](#pull-requests) 14 | 3. [Development Setup](#development-setup) 15 | 4. [Style Guide](#style-guide) 16 | 5. [License](#license) 17 | 18 |
19 | 20 | ## Code of Conduct 21 | 22 | This project and everyone participating in it are governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [maintainer email]. 23 | 24 |
25 | 26 | ## How Can I Contribute? 27 | 28 | ### Reporting Bugs 29 | 30 | - Before creating bug reports, please check the [existing issues](https://github.com/djangoaddicts/django-pygwalker/issues) as you might find that the issue has already been reported. 31 | - When creating a bug report, please include a clear and concise description of the problem and steps to reproduce it. 32 | 33 | ### Suggesting Enhancements 34 | 35 | - Before creating enhancement suggestions, please check the [list of open issues](https://github.com/djangoaddicts/django-pygwalker/issues) as you might find that the suggestion has already been made. 36 | - When creating an enhancement suggestion, please provide a detailed description and, if possible, an implementation proposal. 37 | 38 | ### Pull Requests 39 | 40 | - Provide a clear and concise description of your pull request. 41 | - Ensure you have tested your changes thoroughly. 42 | - Add/update unittests as nessessary. 43 | - Make sure code quaility tools run successfully. 44 | 45 | Merging contributions requires passing the checks configured with the CI. This includes running tests, linters, and other code quaility tools successfully on the currently officially supported Python and Django versions. 46 | 47 |
48 | 49 | ## Development 50 | 51 | You can contribute to this project forking it from GitHub and sending pull requests. 52 | 53 | First [fork](https://help.github.com/en/articles/fork-a-repo) the 54 | [repository](https://github.com/djangoaddicts/django-pygwalker) and then clone it: 55 | 56 | ```shell 57 | git clone git@github.com:/django-pygwalker.git 58 | ``` 59 | 60 | Create a virtual environment and install dependancies: 61 | 62 | ```shell 63 | cd django-pygwalker 64 | python -m venv venv 65 | source venv/bin/activate 66 | pip install .[dev] 67 | ``` 68 | 69 | Unit tests are located under the tests directory and can be executed via pytest: 70 | 71 | ```shell 72 | pytest 73 | ``` 74 | 75 | 76 |
77 | 78 | ## Style Guide 79 | 80 | Follow the coding style outlined in [STYLE_GUIDE.md](STYLE_GUIDE.md). 81 | 82 |
83 | 84 | ## License 85 | 86 | By contributing, you agree that your contributions will be licensed under the [GNU-3 license](../LICENSE). 87 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Feature Request 11 | 12 | **Is your feature request related to a problem? Please describe.** 13 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 14 | 15 | **Describe the solution you'd like** 16 | A clear and concise description of what you want to happen. 17 | 18 | **Describe alternatives you've considered** 19 | A clear and concise description of any alternative solutions or features you've considered. 20 | 21 | **Additional context** 22 | Add any other context or screenshots about the feature request here. 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/question.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Question 3 | about: Ask a question or seek clarification 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | ## Question 11 | 12 | **Describe your question or request for clarification** 13 | 14 | [Please provide as much detail as possible] 15 | 16 | **Additional context** 17 | Add any other context or information relevant to your question. 18 | -------------------------------------------------------------------------------- /.github/STYLE_GUIDE.md: -------------------------------------------------------------------------------- 1 | # Project Style Guide 2 | 3 | This Python style guide provides conventions and best practices for writing clean and maintainable Python code. Adhering to these guidelines will help ensure consistency across projects and enhance the clarity, maintainability, 4 | and readability of the code. 5 | 6 | ## Table of Contents 7 | - [PEP 8](#pep-8) 8 | - [Line Length](#line-length) 9 | - [Naming Conventions](#naming-conventions) 10 | - [Docstrings](#docstrings) 11 | - [Typing](#typing) 12 | - [Virtual Environments](#virtual-environments) 13 | 14 |
15 | 16 | ## PEP 8 17 | 18 | Adhere to the PEP 8 style guide, which is the style guide for Python code. Please make sure to familiarize yourself with PEP 8 guidelines: [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/). 19 | 20 |
21 | 22 | ## Line Length 23 | 24 | The maximum line length for code and comments is set to 120 characters. This allows for better readability without excessively long lines. 25 | 26 |
27 | 28 | ## Naming Conventions 29 | 30 | ### Classes 31 | - Class names should follow the CamelCase convention. 32 | - Class names should be descriptive and represent a clear concept or object. 33 | 34 | Example: 35 | 36 | ```python 37 | class Calculator: 38 | def __init__(self): 39 | # Constructor implementation 40 | 41 | def add(self, x, y): 42 | # Method implementation 43 | ``` 44 | 45 | ### Functions 46 | - Function names should be lowercase, with words separated by underscores. 47 | - Function names should begin with a verb to indicate the action or operation they perform. 48 | 49 | Examples: 50 | 51 | ```python 52 | def calculate_sum(numbers): 53 | """Calculate the sum of a list of numbers.""" 54 | # Function implementation 55 | 56 | def validate_input(user_input): 57 | """Validate user input and return True if valid, False otherwise.""" 58 | # Function implementation 59 | 60 | def process_data(data): 61 | """Process the given data and return the result.""" 62 | # Function implementation 63 | ``` 64 | 65 | ### Variables 66 | Choosing meaningful and consistent variable names is essential for code readability. Follow these conventions: 67 | 68 | - Use lowercase letters with underscores for variable names (snake_case). 69 | - Be descriptive and use meaningful names to indicate the purpose of the variable. 70 | 71 | Examples: 72 | 73 | ```python 74 | # Good variable names 75 | user_name = "John" 76 | num_items = 5 77 | total_amount = 100.50 78 | 79 | # Avoid ambiguous or single-letter names 80 | a = "John" # Not recommended 81 | n = 5 # Not recommended 82 | ``` 83 | 84 | 85 | - Constants should be in uppercase with underscores. 86 | 87 | Examples: 88 | 89 | ```python 90 | MAX_RETRIES = 3 91 | PI = 3.14159 92 | ``` 93 | 94 | - Avoid using names that shadow built-in functions or keywords. 95 | 96 | Example: 97 | 98 | ```python 99 | # Bad: Don't use 'list' as a variable name 100 | list = [1, 2, 3] 101 | 102 | # Good: Choose a different name 103 | my_list = [1, 2, 3] 104 | ``` 105 | 106 | - Use meaningful prefixes and suffixes for variable names where applicable. 107 | 108 | Example: 109 | 110 | ```python 111 | # Prefix 'is_' for boolean variables 112 | is_valid = True 113 | 114 | # Suffix iterators with type (such as '_list') 115 | name_list = ["John", "Mary", "Robert", "Sue"] 116 | ``` 117 | 118 |
119 | 120 | ## Docstrings 121 | 122 | Documenting your code is crucial for understanding its functionality and usage. Use Google-style docstrings to provide clear and concise documentation. 123 | 124 | ### Module Docstring 125 | - Include a module-level docstring at the beginning of each Python file. 126 | - Use triple double-quotes for multi-line docstrings. 127 | 128 | Example: 129 | 130 | ```python 131 | """Module-level docstring. 132 | 133 | This module provides utility functions for handling calculations. 134 | """ 135 | 136 | # Rest of the module code 137 | ``` 138 | 139 | ### Class Docstring 140 | - Include a class-level docstring immediately below the class definition. 141 | - Briefly describe the purpose and usage of the class. 142 | 143 | Example: 144 | 145 | ```python 146 | class Calculator: 147 | """A simple calculator class. 148 | 149 | This class provides basic arithmetic operations such as addition and subtraction. 150 | """ 151 | 152 | def __init__(self): 153 | # Constructor implementation 154 | ``` 155 | 156 | ### Function Docstring 157 | - Include a function-level docstring immediately below the function definition. 158 | - Provide a clear description of the function's purpose, parameters, and return values. 159 | 160 | Example: 161 | 162 | ```python 163 | def calculate_sum(numbers): 164 | """Calculate the sum of a list of numbers. 165 | 166 | Args: 167 | numbers (list): A list of numerical values. 168 | 169 | Returns: 170 | float: The sum of the input numbers. 171 | """ 172 | # Function implementation 173 | 174 | ``` 175 | 176 |
177 | 178 | ## Typing 179 | Python's optional type hints, introduced in PEP 484 and expanded in subsequent PEPs, provide a way to statically indicate the type of variables and function parameters. Proper use of typing can enhance code readability, maintainability, and catch certain types of errors early in the development process. 180 | 181 | ### General Guidelines 182 | 1. **Use Type Hints:** 183 | 184 | Type hints should be used consistently to indicate the expected types of variables and function parameters. 185 | 186 | Example: 187 | 188 | ```python 189 | def add_numbers(a: int, b: int) -> int: 190 | return a + b 191 | ``` 192 | 193 | 2. **Avoid Redundant Type Hints:** 194 | 195 | Avoid providing type hints when the type is obvious from the variable name or the context. 196 | 197 | Example: 198 | 199 | ```python 200 | # Good 201 | name: str = "John" 202 | 203 | # Avoid unnecessary type hint 204 | age = 30 # Type is clear without specifying it 205 | ``` 206 | 207 | 3. **Use Expressive Variable Names:** 208 | 209 | Choose variable names that convey meaning and make type hints redundant. 210 | 211 | Example: 212 | 213 | ```python 214 | def calculate_area(length: float, width: float) -> float: 215 | return length * width 216 | ``` 217 | 218 | 4. **Be Consistent with Typing Styles:** 219 | 220 | Choose a consistent style for type hints, either using the ```:``` notation or the ```->``` notation for function return types. 221 | 222 | Example: 223 | 224 | ```python 225 | # Consistent style with `:` 226 | def greet(name: str) -> None: 227 | print(f"Hello, {name}!") 228 | 229 | # Consistent style with `->` 230 | def multiply(a: int, b: int) -> int: 231 | return a * b 232 | ``` 233 | 234 | ### Specific Typing Practices 235 | 236 | 1. **Type Annotations for Variables:** 237 | 238 | Use type annotations for variables, especially in cases where the type might not be immediately obvious. 239 | 240 | Example: 241 | 242 | ```python 243 | count: int = 0 244 | ``` 245 | 246 | 2. **Type Annotations for Function Parameters and Return Types:** 247 | 248 | Clearly annotate the types of function parameters and return types. 249 | 250 | Example: 251 | 252 | ```python 253 | def calculate_total(items: List[float]) -> float: 254 | return sum(items) 255 | ``` 256 | 257 | 3. **Type Aliases:** 258 | 259 | Use typing module aliases to create readable and self-documenting type aliases for complex types. 260 | 261 | Example: 262 | 263 | ```python 264 | from typing import List, Tuple 265 | 266 | Coordinates = Tuple[float, float] 267 | PointList = List[Coordinates] 268 | 269 | def plot_points(points: PointList) -> None: 270 | # Plotting logic here 271 | ``` 272 | 273 | 4. **Union Types:** 274 | 275 | Use Union types when a variable or parameter can have multiple types. 276 | 277 | Example: 278 | 279 | ```python 280 | from typing import Union 281 | 282 | def display_value(value: Union[int, float, str]) -> None: 283 | print(value) 284 | ``` 285 | 286 | 5. **Type Hinting in Generics:** 287 | 288 | Use generic types when working with containers or collections. 289 | 290 | Example: 291 | 292 | ```python 293 | from typing import List, Tuple 294 | 295 | def process_data(data: List[Tuple[str, int]]) -> None: 296 | # Processing logic here 297 | ``` 298 | 299 | 6. **Callable Types:** 300 | 301 | Clearly annotate callable types using Callable from the typing module. 302 | 303 | 304 | Example: 305 | 306 | ```python 307 | from typing import Callable 308 | 309 | def apply_function(func: Callable[[int, int], int], a: int, b: int) -> int: 310 | return func(a, b) 311 | ``` 312 | 313 |
314 | 315 | ## Virtual Environments 316 | 317 | ### Introduction 318 | 319 | A virtual environment is a self-contained directory that contains a Python interpreter and allows you to install and manage project-specific dependencies. Use a virtual environment to isolate project dependencies and avoid conflicts with system-wide packages. 320 | 321 | 322 | ### Creating a Virtual Environment 323 | To create a virtual environment, use the following command at the **root** of the repository: 324 | 325 | ```shell 326 | python -m venv venv 327 | ``` 328 | 329 | ### Activating the Virtual Environment 330 | Once the virtual environment is created, activate it using the appropriate command for your operating system: 331 | 332 | For Windows: 333 | 334 | ```shell 335 | venv\Scripts\activate 336 | ``` 337 | 338 | For Mac, Linux, and WSL: 339 | 340 | ```shell 341 | source venv/bin/activate 342 | ``` 343 | 344 |
345 | -------------------------------------------------------------------------------- /.github/workflows/bandit.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | bandit: 5 | runs-on: ubuntu-latest 6 | name: "bandit" 7 | steps: 8 | - uses: davidslusser/actions_python_bandit@v1.0.1 9 | with: 10 | src: "src" 11 | options: "-c pyproject.toml -r" 12 | pip_install_command: "pip install .[dev]" 13 | python_version: "3.11" 14 | -------------------------------------------------------------------------------- /.github/workflows/black.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | black: 5 | runs-on: ubuntu-latest 6 | name: "black" 7 | steps: 8 | - uses: davidslusser/actions_python_black@v1.0.1 9 | with: 10 | src: "src" 11 | options: "" 12 | pip_install_command: "pip install .[dev]" 13 | python_version: "3.11" 14 | -------------------------------------------------------------------------------- /.github/workflows/coveralls.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | coveralls: 5 | runs-on: ubuntu-latest 6 | name: "coveralls" 7 | steps: 8 | - name: actions_python_coveralls 9 | uses: davidslusser/actions_python_coveralls@v1.0.0 10 | with: 11 | src: "src" 12 | options: "" 13 | pip_install_command: "pip install -e .[dev]" 14 | coveralls_repo_token: ${{ secrets.COVERALLS_REPO_TOKEN }} 15 | python_version: "3.11" 16 | -------------------------------------------------------------------------------- /.github/workflows/isort.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | isort: 5 | runs-on: ubuntu-latest 6 | name: "isort" 7 | steps: 8 | - uses: davidslusser/actions_python_isort@v1.0.1 9 | with: 10 | src: "src" 11 | python_version: "3.11" 12 | -------------------------------------------------------------------------------- /.github/workflows/mypy.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | mypy: 5 | runs-on: ubuntu-latest 6 | name: "mypy" 7 | steps: 8 | - uses: davidslusser/actions_python_mypy@v1.0.1 9 | with: 10 | src: "src" 11 | options: "" 12 | pip_install_command: "pip install -e .[dev]" 13 | python_version: "3.11" 14 | -------------------------------------------------------------------------------- /.github/workflows/pypi.yaml: -------------------------------------------------------------------------------- 1 | name: Upload Python Package 2 | 3 | on: 4 | release: 5 | types: [created] 6 | workflow_dispatch: 7 | push: 8 | tags: 9 | - '[0-9]+.[0-9]+.[0-9]+-dev' 10 | - '[0-9]+.[0-9]+.[0-9]+-dev.[0-9]+' 11 | - '[0-9]+.[0-9]+.[0-9]+-rc' 12 | - '[0-9]+.[0-9]+.[0-9]+-rc.[0-9]+' 13 | - '[0-9]+.[0-9]+.[0-9]+' 14 | 15 | jobs: 16 | pypi: 17 | runs-on: ubuntu-latest 18 | name: "pypi" 19 | steps: 20 | - uses: davidslusser/actions_python_pypi@v1.0.2 21 | with: 22 | build_command: "python -m build" 23 | pypi_username: ${{ secrets.PYPI_USERNAME }} 24 | pypi_password: ${{ secrets.PYPI_PASSWORD }} 25 | -------------------------------------------------------------------------------- /.github/workflows/pytest.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | pytest: 5 | runs-on: ubuntu-latest 6 | name: "pytest" 7 | steps: 8 | - uses: davidslusser/actions_python_pytest@v1.0.1 9 | with: 10 | src: "" 11 | options: "--cov=src" 12 | pip_install_command: "pip install -e .[dev]" 13 | python_version: "3.11" 14 | -------------------------------------------------------------------------------- /.github/workflows/radon.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | radon: 5 | runs-on: ubuntu-latest 6 | name: "radon" 7 | steps: 8 | - uses: actions/checkout@v3 9 | - uses: davidslusser/actions_python_radon@v1.0.0 10 | with: 11 | src: "src" 12 | -------------------------------------------------------------------------------- /.github/workflows/ruff.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | ruff: 5 | runs-on: ubuntu-latest 6 | name: "ruff" 7 | steps: 8 | - name: actions_python_ruff 9 | uses: davidslusser/actions_python_ruff@v1.0.2 10 | with: 11 | src: "src" 12 | options: "-v" 13 | python_version: "3.11" 14 | -------------------------------------------------------------------------------- /.github/workflows/safety.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | safety: 5 | runs-on: ubuntu-latest 6 | name: "safety" 7 | steps: 8 | - uses: davidslusser/actions_python_safety@v1.0.2 9 | with: 10 | options: "" 11 | pip_install_command: "pip install -e .[dev]" 12 | -------------------------------------------------------------------------------- /.github/workflows/tox.yaml: -------------------------------------------------------------------------------- 1 | on: [push] 2 | 3 | jobs: 4 | tox: 5 | name: Test with Python ${{ matrix.python-version }} & Django ${{ matrix.django-version }} 6 | runs-on: ubuntu-latest 7 | 8 | strategy: 9 | fail-fast: false 10 | matrix: 11 | python-version: ['3.8', '3.9', '3.10', '3.11'] 12 | django-version: ['3.2', '4.0', '4.1', '4.2', 'main'] 13 | 14 | steps: 15 | - uses: actions/checkout@v3 16 | 17 | - name: "Set up Python ${{ matrix.python-version }}" 18 | uses: actions/setup-python@v4 19 | with: 20 | python-version: ${{ matrix.python-version }} 21 | 22 | - name: "Install Python Dependencies" 23 | run: | 24 | python -m pip install --upgrade pip 25 | pip install -e .[dev] 26 | 27 | - name: "Run tests via Tox" 28 | run: | 29 | tox -v 30 | env: 31 | DJANGO: ${{ matrix.django-version }} 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # other 132 | local_test 133 | .vscode 134 | *__version__.py 135 | src/__version__.py 136 | 137 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | exclude * 2 | include pyproject.toml 3 | 4 | 5 | # Include the src files 6 | recursive-include src * 7 | 8 | recursive-exclude docs * 9 | recursive-exclude tests * 10 | recursive-exclude .github * 11 | recursive-exclude src/*.egg-info 12 | 13 | global-exclude */__pycache__/* 14 | global-exclude *.pyc 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # django-pygwalker 2 | ![](https://img.shields.io/pypi/v/django-pygwalker?color=blue) 3 | [![Downloads](https://static.pepy.tech/badge/django-pygwalker)](https://pepy.tech/project/django-pygwalker) 4 | ![](https://img.shields.io/pypi/status/django-pygwalker) 5 | 6 | [![Maintainability](https://api.codeclimate.com/v1/badges/23aa8dc3c2e30ac40cb4/maintainability)](https://codeclimate.com/github/djangoaddicts/django-pygwalker/maintainability) 7 | [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7682/badge)](https://bestpractices.coreinfrastructure.org/projects/7682) 8 | 9 | ![PyPI - Python](https://img.shields.io/pypi/pyversions/django-pygwalker) 10 | ![PyPI - Django](https://img.shields.io/pypi/djversions/django-pygwalker) 11 | 12 | 13 | 14 | This utility creates user interfaces for visual analysis using PyGWalker in your django application. A PyGWalker page can be created from a Django queryset, a static csv file, or an uploaded csv file. 15 | 16 | For more information on PyGWalker see the github repo available here: https://github.com/Kanaries/pygwalker 17 | 18 | 19 |
20 | 21 | ## Code Quality 22 | | Workflow | Description | Status | 23 | |----------|-------------------------|------------------------------------------------------------------------------| 24 | |Bandit|security checks|![Bandit](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/bandit.yaml/badge.svg)| 25 | |Black|code formatting|![Black](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/black.yaml/badge.svg)| 26 | |CodeQL|security analysis|[![CodeQL](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/github-code-scanning/codeql)| 27 | |Coveralls|code coverage status|![Coveralls](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/coveralls.yaml/badge.svg)| 28 | |Isort|python import ordering|![Isort](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/isort.yaml/badge.svg)| 29 | |Mypy|static type checking|![Mypy](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/mypy.yaml/badge.svg)| 30 | |Pytest|unit testing|![Pytest](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/pytest.yaml/badge.svg)| 31 | |Radon|code complexity analysis|![Radon](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/radon.yaml/badge.svg)| 32 | |Ruff|static code analysis|![Ruff](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/ruff.yaml/badge.svg)| 33 | |Safety|dependency scanner|![Saftey](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/safety.yaml/badge.svg)| 34 | |Tox|python/django versions testing|![Tox](https://github.com/djangoaddicts/django-pygwalker/actions/workflows/tox.yaml/badge.svg)| 35 | 36 | 37 | ### Code Coverage 38 | [![Coverage Status](https://coveralls.io/repos/github/djangoaddicts/django-pygwalker/badge.svg)](https://coveralls.io/github/djangoaddicts/django-pygwalker) 39 | 40 | Dashboard: 41 | https://coveralls.io/github/djangoaddicts/django-pygwalker 42 | 43 | 44 |
45 | 46 | ## Documentation 47 | [![Documentation Status](https://readthedocs.org/projects/django-pygwalker/badge/?version=latest)](https://django-pygwalker.readthedocs.io/en/latest/?badge=latest) 48 | 49 | Full documentation can be found on http://django-pygwalker.readthedocs.org. 50 | 51 | Documentation source files are available in the docs folder. 52 | 53 | 54 |
55 | 56 | ## Installation 57 | - install via pip: 58 | ``` 59 | pip install django-pygwalker 60 | ``` 61 | - add the following to your INSTALLED_APPS in settings.py: 62 | 63 | ```python 64 | djangoaddicts.pygwalker 65 | ``` 66 | 67 | ***NOTE:*** *adding djangoaddicts.pygwalker to INSTALLED_APPS is only required if you intend to use the built-in templates or the 'generic' PyGWalker view.* 68 | 69 | - to include the generic PyGWalker view (creates the PyGWalker page from an upload of a csv file) add the following to your project-level urls.py: 70 | 71 | ```python 72 | path("pygwalker/", include("djangoaddicts.pygwalker.urls"), ), 73 | ``` 74 | 75 | 76 |
77 | 78 | ## Features 79 | 80 | ### PygWalkerView 81 | The PygWalkerView renders a page containing PyGWalker html. This view takes a queryset parameter and includes all data in the queryset for visualizations. By default fields defined in the model will be included. To exclude fields or include additional fields (such as related fields), use the field_list parameter to specify exact fields desired for visualizations. 82 | 83 | A Bootstrap 5 template is included, but can be overwritten using the template_name parameter. 84 | 85 | #### Parameters 86 | - **field_list:** list of model fields to include (defaults to fields defined in the model) 87 | - **queryset:** queryset providing data available to visualization 88 | - **theme:** PyGWalker theme to use for pyg html (defaults to "media") 89 | - **title:** title used on html render 90 | - **template_name:** template used when rendering page; (defaults to pygwalker/bs5/pygwalker.html) 91 | 92 | 93 |
94 | 95 | ## Usage Examples 96 | 97 | ```python 98 | from djangoaddicts.pygwalker.views import PygWalkerView 99 | 100 | class MyPygWalkerView(PygWalkerView): 101 | queryset = MyModel.objects.all() 102 | ``` 103 | 104 | #### Explicitly Defined Fields 105 | 106 | ```python 107 | from djangoaddicts.pygwalker.views import PygWalkerView 108 | 109 | class MyPygWalkerView(PygWalkerView): 110 | queryset = MyModel.objects.all() 111 | title = "MyModel Data Analysis" 112 | theme = "light" 113 | field_list = ["name", "some_field", "some_other__related_field", "id", "created_at", "updated_at"] 114 | ``` 115 | 116 | #### Custom Template 117 | Custom views/templates can be used to override the Bootstrap 5 templates provided by default view. Here is an example: 118 | 119 | ```python 120 | from djangoaddicts.pygwalker.views import PygWalkerView 121 | 122 | class MyPygWalkerView(PygWalkerView): 123 | queryset = MyModel.objects.all() 124 | template_name = "my_custom_template.html" 125 | ``` 126 | 127 |
128 | 129 | ## License 130 | django-pygwalker is licensed under the GNU-3 license (see the LICENSE file for details). 131 | 132 | https://github.com/djangoaddicts/django-pygwalker/blob/main/LICENSE 133 | 134 |
135 | 136 | ## Contributing 137 | To contribute to django-pygwalker, please see [Contributing](.github/CONTRIBUTING.md) 138 | -------------------------------------------------------------------------------- /docs/.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | # .readthedocs.yaml 2 | # Read the Docs configuration file 3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 4 | 5 | # Required 6 | version: 2 7 | 8 | # Set the version of Python and other tools you might need 9 | build: 10 | os: ubuntu-22.04 11 | tools: 12 | python: "3.11" 13 | 14 | # Build documentation in the docs/ directory with Sphinx 15 | sphinx: 16 | configuration: docs/source/conf.py 17 | 18 | # We recommend specifying your dependencies to enable reproducible builds: 19 | # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html 20 | python: 21 | install: 22 | - method: pip 23 | path: . 24 | extra_requirements: 25 | - docs 26 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = source 9 | BUILDDIR = build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /docs/django_settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Minimal file so Sphinx can work with Django for autodocumenting. 3 | 4 | Location: /docs/django_settings.py 5 | """ 6 | 7 | # INSTALLED_APPS with these apps is necessary for Sphinx to build 8 | # without warnings & errors 9 | # Depending on your package, the list of apps may be different 10 | INSTALLED_APPS = [ 11 | "django.contrib.auth", 12 | "django.contrib.contenttypes", 13 | "djangoaddicts.pygwalker", 14 | "handyhelpers", 15 | ] 16 | 17 | 18 | TEMPLATES = [ 19 | { 20 | "BACKEND": "django.template.backends.django.DjangoTemplates", 21 | "APP_DIRS": True, 22 | "OPTIONS": { 23 | "context_processors": [ 24 | "django.template.context_processors.debug", 25 | "django.template.context_processors.request", 26 | "django.contrib.auth.context_processors.auth", 27 | "django.contrib.messages.context_processors.messages", 28 | ], 29 | }, 30 | }, 31 | ] 32 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=source 11 | set BUILDDIR=build 12 | 13 | %SPHINXBUILD% >NUL 2>NUL 14 | if errorlevel 9009 ( 15 | echo. 16 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 17 | echo.installed, then set the SPHINXBUILD environment variable to point 18 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 19 | echo.may add the Sphinx directory to PATH. 20 | echo. 21 | echo.If you don't have Sphinx installed, grab it from 22 | echo.https://www.sphinx-doc.org/ 23 | exit /b 1 24 | ) 25 | 26 | if "%1" == "" goto help 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /docs/source/about.md: -------------------------------------------------------------------------------- 1 | # About 2 | 3 | This utility creates user interfaces for visual analysis using PyGWalker in your django application. A PyGWalker page can be created from a Django queryset, a static csv file, or an uploaded csv file. 4 | 5 | For more information on PyGWalker see the github repo available here: 6 | 7 |
8 | 9 | ## Requirements & Dependencies 10 | 11 | django-pygwalker is built on Python 3.10.x and Django 4.2.x. For a full list of packages and requirements, please 12 | see the install_requires in the pyproject.toml file. 13 | 14 |
15 | -------------------------------------------------------------------------------- /docs/source/coc.md: -------------------------------------------------------------------------------- 1 | ```{include} ../../.github/CODE_OF_CONDUCT.md 2 | ``` -------------------------------------------------------------------------------- /docs/source/conf.py: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # For the full list of built-in configuration values, see the documentation: 4 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 5 | 6 | # -- Project information ----------------------------------------------------- 7 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information 8 | 9 | import os 10 | import sys 11 | 12 | import django 13 | print(os.path.abspath("../../src")) 14 | 15 | # Note: You may need to change the path to match 16 | # your project's structure 17 | sys.path.insert(0, os.path.abspath("../../src")) 18 | sys.path.insert(0, os.path.abspath("..")) # For discovery of Python modules 19 | sys.path.insert(0, os.path.abspath(".")) # For finding the django_settings.py file 20 | 21 | # This tells Django where to find the settings file 22 | os.environ["DJANGO_SETTINGS_MODULE"] = "django_settings" 23 | # This activates Django and makes it possible for Sphinx to 24 | # autodoc your project 25 | django.setup() 26 | 27 | project = 'django-pygwalker' 28 | copyright = '2023, David Slusser' 29 | author = 'David Slusser' 30 | 31 | # -- General configuration --------------------------------------------------- 32 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration 33 | 34 | extensions = ['sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc', 'myst_parser'] 35 | 36 | templates_path = ['_templates'] 37 | exclude_patterns = [] 38 | 39 | source_suffix = { 40 | '.rst': 'restructuredtext', 41 | '.txt': 'markdown', 42 | '.md': 'markdown', 43 | } 44 | 45 | # -- Options for HTML output ------------------------------------------------- 46 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output 47 | 48 | html_theme = "sphinx_rtd_theme" 49 | html_static_path = ['_static'] 50 | -------------------------------------------------------------------------------- /docs/source/contributing.md: -------------------------------------------------------------------------------- 1 | ```{include} ../../.github/CONTRIBUTING.md 2 | ``` -------------------------------------------------------------------------------- /docs/source/features.md: -------------------------------------------------------------------------------- 1 | # Features 2 | 3 | ## PygWalkerView 4 | 5 | The PygWalkerView view renders a page containing PyGWalker html. This view takes a queryset parameter and includes all data in the queryset for visualizations. By default fields defined in the model will be included. To exclude fields or include additional fields (such as related fields), use the field_list parameter to specify exact fields desired for visualizations. 6 | 7 | A Bootstrap 5 template is included, but can be overwritten using the template_name parameter. 8 | 9 | ### Parameters 10 | - **field_list:** list of model fields to include (defaults to fields defined in the model) 11 | - **queryset:** queryset providing data available to visualization 12 | - **theme:** PyGWalker theme to use for pyg html (defaults to "media") 13 | - **title:** title used on html render 14 | - **template_name:** template used when rendering page; (defaults to pygwalker/bs5/pygwalker.html) 15 | 16 | ### Usage Examples 17 | 18 | ```python 19 | from djangoaddicts.pygwalker.views import PygWalkerView 20 | 21 | class MyPygWalkerView(PygWalkerView): 22 | queryset = MyModel.objects.all() 23 | ``` 24 | 25 | ##### Explicitly Defined Fields 26 | 27 | ```python 28 | from djangoaddicts.pygwalker.views import PygWalkerView 29 | 30 | class MyPygWalkerView(PygWalkerView): 31 | queryset = MyModel.objects.all() 32 | title = "MyModel Data Analysis" 33 | theme = "light" 34 | field_list = ["name", "some_field", "some_other__related_field", "id", "created_at", "updated_at"] 35 | ``` 36 | 37 | 38 | ##### Custom Template 39 | Custom views/templates can be used to override the Bootstrap 5 templates provided. Here is an example: 40 | 41 | ```python 42 | from djangoaddicts.pygwalker.views import PygWalkerView 43 | 44 | class MyPygWalkerView(PygWalkerView): 45 | queryset = MyModel.objects.all() 46 | template_name = "my_custom_template.html" 47 | ``` 48 | 49 | 50 |
51 | 52 | ## StaticCsvPygWalkerView 53 | 54 | The StaticCsvPygWalkerView view renders a page containing PyGWalker html with data sourced from a static csv file. 55 | 56 | A Bootstrap 5 template is included, but can be overwritten using the template_name parameter. 57 | 58 | ### Parameters 59 | - **csv_file:** csv file containing data to visualize 60 | - **theme:** PyGWalker theme to use for pyg html (defaults to "media") 61 | - **title:** title used on html render 62 | - **template_name:** template used when rendering page; (defaults to pygwalker/bs5/pygwalker.html) 63 | 64 | 65 | ### Usage Examples 66 | 67 | ```python 68 | from djangoaddicts.pygwalker.views import StaticCsvPygWalkerView 69 | 70 | class MyPygWalkerView(StaticCsvPygWalkerView): 71 | csv_file = "my_csv_file.csv 72 | ``` 73 | 74 | ##### Custom Template 75 | Custom views/templates can be used to override the Bootstrap 5 templates provided. Here is an example: 76 | 77 | ```python 78 | from djangoaddicts.pygwalker.views import StaticCsvPygWalkerView 79 | 80 | class MyPygWalkerView(StaticCsvPygWalkerView): 81 | csv_file = "my_csv_file.csv 82 | template_name = "my_custom_template.html" 83 | ``` 84 | 85 | 86 |
87 | 88 | ## DynamicCsvPygWalkerView 89 | 90 | The DynamicCsvPygWalkerView view is page that allows users to upload a csv file and creates the PyGWalker interface based on data in the uploaded csv file. To use this view, add the following to your INSTALLED_APPS in settings.py: 91 | 92 | ```python 93 | djangoaddicts.pygwalker 94 | ``` 95 | and add the following to your project-level urls.py: 96 | 97 | ```python 98 | path("pygwalker/", include("djangoaddicts.pygwalker.urls"), ), 99 | ``` 100 | 101 | The page can be reached using a link such as: 102 | 103 | ```python 104 | my link 105 | ``` 106 | 107 | ### Page Examples 108 | 109 | #### Initial Page 110 | ![initial page](images/pyg_upload.png) 111 | 112 | #### Rendered Visualization 113 | ![rendered visualization](images/pyg_chart.png) 114 | 115 | 116 |
117 | 118 | ## GenericPygWalkerView 119 | 120 | The GenericPygWalkerView creates a PyGWalker visualization interface from a provided app and model passed as kwargs. If query parameters are present, it includes only filtered data, based on query parameters, in the PyGWalker interface. To use this view, add the following to your INSTALLED_APPS in settings.py: 121 | 122 | ```python 123 | djangoaddicts.pygwalker 124 | ``` 125 | and add the following to your project-level urls.py: 126 | 127 | ```python 128 | path("generic_pyg///", GenericPygWalkerView.as_view(), name="generic_pyg"), 129 | ``` 130 | 131 | The page can be reached using a link such as: 132 | 133 | ```python 134 | my pygwalker link 135 | ``` 136 | 137 | 138 |
139 | 140 | ## PygWalkerListView 141 | 142 | The PygWalkerListView is a list view that extends the HandyHelperListView (from handyhelpers) to add an icon for a PyGWalker visualzation interface. If the list view is filtered, include only filtered data in the PyGWalker interface. 143 | 144 | A Bootstrap 5 template is included, but can be overwritten using the template_name parameter. 145 | 146 | ### Usage Examples 147 | 148 | ```python 149 | from djangoaddicts.pygwalker.views import PygWalkerListView 150 | 151 | class ListProducts(PygWalkerListView): 152 | """list available MyModel entries""" 153 | queryset = MyModel.objects.all() 154 | title = "MyModel Entries" 155 | table = "myapp/table/mymodels.htm" 156 | ``` 157 | 158 | 159 |
160 | 161 | ## PygWalkerPaginatedListView 162 | 163 | The PygWalkerPaginatedListView is a list view that extends the HandyHelperPaginatedListView (from handyhelpers) to add an icon for a PyGWalker visualzation interface. If the list view is filtered, include only filtered data in the PyGWalker interface. 164 | 165 | A Bootstrap 5 template is included, but can be overwritten using the template_name parameter. 166 | 167 | ### Usage Examples 168 | 169 | ```python 170 | from djangoaddicts.pygwalker.views import PygWalkerPaginatedListView 171 | 172 | class ListProducts(PygWalkerPaginatedListView): 173 | """list available MyModel entries""" 174 | queryset = MyModel.objects.all() 175 | title = "MyModel Entries" 176 | table = "myapp/table/mymodels.htm" 177 | ``` 178 | 179 |
180 | -------------------------------------------------------------------------------- /docs/source/images/pyg_chart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/docs/source/images/pyg_chart.png -------------------------------------------------------------------------------- /docs/source/images/pyg_upload.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/docs/source/images/pyg_upload.png -------------------------------------------------------------------------------- /docs/source/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to django-pygwalker's documentation! 2 | 3 | ```{toctree} 4 | :maxdepth: 2 5 | 6 | about 7 | installation 8 | features 9 | internals 10 | version_history 11 | license 12 | coc 13 | contributing 14 | style_guide 15 | ``` 16 | 17 |
18 | -------------------------------------------------------------------------------- /docs/source/installation.md: -------------------------------------------------------------------------------- 1 | # Installation 2 | 3 | The django-pygwalker package is available on Python Package Index (PyPI) and can be installed via pip with the following command: 4 | 5 | ```console 6 | pip install django-pygwalker 7 | ``` 8 | 9 |
10 | 11 | To use django-pygwalker in your project, add 'djangoaddicts.pygwalker' to INSTALLED_APPS in your settings.py file. 12 | 13 | ```python 14 | INSTALLED_APPS = [ 15 | ... 16 | 'djangoaddicts.pygwalker', 17 | ] 18 | ``` 19 | 20 |
21 | 22 | ***NOTE:*** *adding djangoaddicts.pygwalker to INSTALLED_APPS is only required if you intend to use the built-in templates or the 'generic' PyGWalker view.* 23 | 24 | 25 |
26 | 27 | To include the generic PyGWalker view (creates the PyGWalker page from an upload of a csv file) add the following to your project-level urls.py: 28 | 29 | ```python 30 | path("pygwalker/", include("djangoaddicts.pygwalker.urls"), ), 31 | ``` 32 | 33 |
34 | -------------------------------------------------------------------------------- /docs/source/internals.md: -------------------------------------------------------------------------------- 1 | # Internals 2 | 3 | The documentation below details some of the internal workings of django-pygwalker and its components. This documentation is automatically generated from the source code. See the source code in github for full details. 4 | 5 | 6 | 7 |
8 | 9 | ## Views 10 | 11 | ```{eval-rst} 12 | .. automodule:: djangoaddicts.pygwalker.views 13 | :members: PygWalkerView, StaticCsvPygWalkerView, DynamicCsvPygWalkerView, GenericPygWalkerView, PygWalkerListViewMixin, PygWalkerListView, PygWalkerPaginatedListView 14 | ``` 15 | 16 |
17 | -------------------------------------------------------------------------------- /docs/source/license.md: -------------------------------------------------------------------------------- 1 | # License 2 | 3 | ```{eval-rst} 4 | .. include:: ../../LICENSE 5 | ``` 6 | -------------------------------------------------------------------------------- /docs/source/style_guide.md: -------------------------------------------------------------------------------- 1 | ```{include} ../../.github/STYLE_GUIDE.md 2 | ``` -------------------------------------------------------------------------------- /docs/source/version_history.md: -------------------------------------------------------------------------------- 1 | # Version History 2 | 3 |
4 | 5 | | Release | Details | 6 | |----------|--------| 7 | | 0.0.9 | updates to support the latest pygwalker (0.4.9.8 at time of publishing) | 8 | | 0.0.8 | updating styleguide; chaning default base template for detail pages | 9 | | 0.0.7 | updates for latest pygwalker; adding handling for empty dataframe | 10 | | 0.0.6 | adding query parameter filtering in PygWalkerView | 11 | | 0.0.5 | adding PyGWalker paginaged list view | 12 | | 0.0.4 | adding PyGWalker list view | 13 | | 0.0.3 | adding view for uploadable csv file | 14 | | 0.0.2 | adding view for static csv file | 15 | | 0.0.1 | initial release | 16 | 17 |
18 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | build-backend = "setuptools.build_meta" 3 | requires = [ 4 | "build", 5 | "setuptools >= 67.7.2", 6 | "setuptools_scm >= 7.1", 7 | "wheel >= 0.40.0" 8 | ] 9 | 10 | 11 | [project] 12 | authors = [ 13 | {name = "David Slusser", email = "dbslusser@gmail.com"}, 14 | ] 15 | classifiers = [ 16 | "Development Status :: 5 - Production/Stable", 17 | "Environment :: Web Environment", 18 | "Framework :: Django", 19 | "Framework :: Django :: 3.2", 20 | "Framework :: Django :: 4.0", 21 | "Framework :: Django :: 4.1", 22 | "Framework :: Django :: 4.2", 23 | "Intended Audience :: Developers", 24 | "Operating System :: OS Independent", 25 | "Programming Language :: Python", 26 | "Programming Language :: Python :: 3 :: Only", 27 | "Programming Language :: Python :: 3.8", 28 | "Programming Language :: Python :: 3.9", 29 | "Programming Language :: Python :: 3.10", 30 | "Programming Language :: Python :: 3.11", 31 | "Topic :: Software Development :: Libraries :: Python Modules", 32 | ] 33 | dependencies = [ 34 | "django", 35 | "django-handyhelpers >= 0.3.10", 36 | "pandas", 37 | "pygwalker", 38 | ] 39 | description = "PyGWalker views for Django projects" 40 | dynamic = ["version"] 41 | keywords = ["django", "visualization", "data-analysis", "data-exploration", "tableau", "tableau-alternative",] 42 | license = {file = "LICENSE"} 43 | name = "django-pygwalker" 44 | readme = "README.md" 45 | requires-python = ">=3.8" 46 | 47 | 48 | [project.optional-dependencies] 49 | dev = [ 50 | "bandit", 51 | "black", 52 | "build", 53 | "coveralls", 54 | "django-environ", 55 | "isort", 56 | "model-bakery", 57 | "mypy", 58 | "mypy-extensions", 59 | "ruff", 60 | "pytest", 61 | "pytest-cov", 62 | "pytest-django", 63 | "radon", 64 | "safety", 65 | "setuptools >= 67.7.2", 66 | "setuptools_scm >= 7.1", 67 | "tox", 68 | "tox-gh-actions", 69 | "types-python-dateutil", 70 | "typing_extensions", 71 | "wheel >= 0.40.0", 72 | ] 73 | 74 | docs = [ 75 | "sphinx", 76 | "sphinx-rtd-theme", 77 | "myst-parser", 78 | ] 79 | 80 | 81 | [project.urls] 82 | homepage = "https://github.com/djangoaddicts/django-pygwalker" 83 | repository = "https://github.com/djangoaddicts/django-pygwalker" 84 | 85 | 86 | [tool.bandit] 87 | exclude_dirs = ["venv", "tests"] 88 | 89 | 90 | [tool.black] 91 | line-length = 120 92 | 93 | 94 | [tool.coverage.report] 95 | show_missing = true 96 | 97 | 98 | [tool.coverage.run] 99 | branch = true 100 | omit = ["*_test.py", "*/tests/*", "*__version__.py", "setup.py"] 101 | relative_files = true 102 | source = ["src"] 103 | 104 | 105 | [tool.isort] 106 | profile = "black" 107 | 108 | 109 | [tool.mypy] 110 | exclude = ['venv/*'] 111 | ignore_missing_imports = true 112 | 113 | 114 | # https://docs.pytest.org/en/6.2.x/customize.html#pyproject-toml 115 | [tool.pytest.ini_options] 116 | addopts = "-s -v -x --strict-markers -m 'not extra' --doctest-modules" 117 | filterwarnings = [ 118 | "ignore::UserWarning", 119 | ] 120 | testpaths = ["tests"] 121 | 122 | 123 | [tool.ruff] 124 | line-length = 120 125 | 126 | 127 | [tool.setuptools_scm] 128 | write_to = "src/__version__.py" 129 | 130 | 131 | [tool.tox] 132 | legacy_tox_ini = """ 133 | [tox] 134 | env_list = 135 | py{38,39,310,311}-dj32, 136 | py{38,39,310,311}-dj40, 137 | py{38,39,310,311}-dj41, 138 | py{38,39,310,311}-dj42, 139 | py{38,39,310,311}-djmain, 140 | 141 | [gh-actions] 142 | python = 143 | 3.8: py38 144 | 3.9: py39 145 | 3.10: py310 146 | 3.11: py311 147 | 3.12: py312 148 | 149 | [gh-actions:env] 150 | DJANGO = 151 | 3.2: dj32 152 | 4.0: dj40 153 | 4.1: dj41 154 | 4.2: dj42 155 | main: djmain 156 | 157 | [testenv] 158 | deps = 159 | -e .[dev] 160 | dj32: Django>=3.2,<3.3 161 | dj40: Django>=4.0,<4.1 162 | dj41: Django>=4.1,<4.2 163 | dj42: Django>=4.2,<4.3 164 | dmain: https://github.com/django/django/tarball/main 165 | 166 | commands = pytest 167 | """ 168 | -------------------------------------------------------------------------------- /src/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/src/__init__.py -------------------------------------------------------------------------------- /src/djangoaddicts/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/src/djangoaddicts/__init__.py -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/src/djangoaddicts/pygwalker/__init__.py -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class PygwalkerConfig(AppConfig): 5 | name = "djangoaddicts.pygwalker" 6 | verbose_name = "Data Analysis with PyGWalker" 7 | -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/forms.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | 3 | 4 | class UploadFileForm(forms.Form): 5 | """simple form for uploading a csv file""" 6 | 7 | csv_file = forms.FileField() 8 | -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/partials/file_upload.htm: -------------------------------------------------------------------------------- 1 |
2 |
3 | {% csrf_token %} 4 |
5 |
6 | 7 |
8 |
9 | 10 |
11 |
12 |
13 |
-------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/partials/footer.htm: -------------------------------------------------------------------------------- 1 |
2 | Visualizations powered by PyGWalker: https://github.com/Kanaries/pygwalker 3 |
-------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/partials/header.htm: -------------------------------------------------------------------------------- 1 |
2 |
3 |
4 |
{{ title|safe }}
5 |
6 |
7 |
-------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/partials/pyg.htm: -------------------------------------------------------------------------------- 1 |
2 |
3 | {{ pyg|safe }} 4 |
5 |
-------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/partials/pygwalker_nav_menu.htm: -------------------------------------------------------------------------------- 1 | {% comment %} 2 | This partial adds a link to the pygwalker view provided by django-pygwalker and is designed to be used within a 3 | bootstrap 5 navbar. 4 | 5 | To use this, add the following in your navbar where appropriate: 6 | {% include 'pygwalker/bs5/partials/pygwalker_nav_menu.htm' %} 7 | 8 | {% endcomment %} 9 | 10 | 11 | 18 | -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/pygwalker.html: -------------------------------------------------------------------------------- 1 | {% extends BASE_TEMPLATE|default:"handyhelpers/handyhelpers_base_bs5.htm" %} 2 | 3 | {% block content %} 4 |
5 | {% include "pygwalker/bs5/partials/header.htm" %} 6 |
7 | {% if pyg %} 8 |
9 | {% include "pygwalker/bs5/partials/pyg.htm" %} 10 |
11 |
12 | {% include "pygwalker/bs5/partials/footer.htm" %} 13 |
14 | {% elif no_data %} 15 |
16 | {{ no_data }} 17 |
18 | {% endif %} 19 | {% endblock content %} 20 | -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/templates/pygwalker/bs5/pygwalker_dynamic.html: -------------------------------------------------------------------------------- 1 | {% extends BASE_TEMPLATE|default:"handyhelpers/handyhelpers_base_bs5.htm" %} 2 | 3 | {% block content %} 4 |
5 | {% include "pygwalker/bs5/partials/header.htm" %} 6 |
7 |
8 | {% include "pygwalker/bs5/partials/file_upload.htm" %} 9 |
10 |
11 | {% include "pygwalker/bs5/partials/pyg.htm" %} 12 |
13 |
14 | {% include "pygwalker/bs5/partials/footer.htm" %} 15 |
16 | {% endblock content %} 17 | -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path 2 | 3 | from djangoaddicts.pygwalker.views import DynamicCsvPygWalkerView, GenericPygWalkerView 4 | 5 | app_name = "pygwalker" 6 | 7 | urlpatterns = [ 8 | path("", DynamicCsvPygWalkerView.as_view(), name=""), 9 | path("csv", DynamicCsvPygWalkerView.as_view(), name="csv"), 10 | path("dynamic", DynamicCsvPygWalkerView.as_view(), name="dynamic"), 11 | path("file", DynamicCsvPygWalkerView.as_view(), name="file"), 12 | path("generic_pyg///", GenericPygWalkerView.as_view(), name="generic_pyg"), 13 | ] 14 | -------------------------------------------------------------------------------- /src/djangoaddicts/pygwalker/views.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | import mimetypes 4 | 5 | import pandas as pd 6 | import pygwalker as pyg 7 | from django.apps import apps 8 | from django.conf import settings 9 | from django.contrib import messages 10 | from django.db.models import QuerySet 11 | from django.shortcuts import render 12 | from django.views.generic import View 13 | from handyhelpers.views.gui import HandyHelperListView, HandyHelperPaginatedListView 14 | 15 | from djangoaddicts.pygwalker.forms import UploadFileForm 16 | 17 | 18 | class PygWalkerView(View): 19 | """View to create a PyGWalker visualization interface from a Django queryset. 20 | See https://github.com/Kanaries/pygwalker for more information on PyGWalker. 21 | 22 | class parameters: 23 | field_list - list of model fields to include; defaults to fields defined in the model 24 | queryset - queryset providing data available to visualization 25 | template_name - template used when rendering page; defaults to: pygwalker/bs5/pyg.html 26 | theme - PyGWalker theme to use for pyg html; defaults to: "media" 27 | title - title used on html render 28 | 29 | example: 30 | 31 | from djangoaddicts.pygwalker.views import PygWalkerView 32 | class MyPygView(PygWalkerView): 33 | queryset = Order.objects.all() 34 | title = "Order Data Analysis" 35 | theme = "light" 36 | field_list = ["status__name", "customer", "order_id", "created_at", "updated_at", "products"] 37 | """ 38 | 39 | field_list: list = [] 40 | queryset: QuerySet = None 41 | template_name: str = "pygwalker/bs5/pygwalker.html" 42 | theme: str = getattr(settings, "PYGWALKER_THEME", "media") 43 | title: str | None = None 44 | 45 | def get(self, request): 46 | referrer = request.META.get("HTTP_REFERER", "") 47 | if "?" in referrer: 48 | query_dict = { 49 | key: value for key, value in (item.split("=") for item in referrer.split("?")[1].split("&") if item) 50 | } 51 | else: 52 | query_dict = {} 53 | self.queryset = self.queryset.filter(**query_dict) 54 | if not self.title: 55 | self.title = f"{self.queryset.model._meta.model_name.title()} Analysis" 56 | pd_data = pd.DataFrame(list(self.queryset.values(*self.field_list))) 57 | if pd_data.empty: 58 | context = {"no_data": f"no {self.queryset.model.__name__} data found", "title": self.title} 59 | else: 60 | context = {"pyg": pyg.to_html(pd_data, appearance=self.theme), "title": self.title} 61 | return render(request, self.template_name, context) 62 | 63 | 64 | class StaticCsvPygWalkerView(View): 65 | """View to create a PyGWalker visualization interface from a statically definied csv file. 66 | See https://github.com/Kanaries/pygwalker for more information on PyGWalker. 67 | 68 | class parameters: 69 | csv_file - csv file containing data to visualize 70 | template_name - template used when rendering page; defaults to: pygwalker/bs5/pyg.html 71 | theme - PyGWalker theme to use for pyg html; defaults to: "media" 72 | title - title used on html render 73 | 74 | example: 75 | 76 | from djangoaddicts.pygwalker.views import StaticCsvPygWalkerView 77 | class MyPygView(StaticCsvPygWalkerView): 78 | csv_file = "my_csv_file.csv 79 | title = "Order Data Analysis" 80 | theme = "light" 81 | """ 82 | 83 | csv_file = None 84 | template_name: str = "pygwalker/bs5/pygwalker.html" 85 | theme: str = getattr(settings, "PYGWALKER_THEME", "media") 86 | title: str = "Data Analysis" 87 | 88 | def get(self, request): 89 | pd_data = pd.read_csv(self.csv_file) 90 | context = {"pyg": pyg.to_html(pd_data, appearance=self.theme), "title": self.title} 91 | return render(request, self.template_name, context) 92 | 93 | 94 | class DynamicCsvPygWalkerView(View): 95 | """View to create a PyGWalker visualization interface from a provided csv file. 96 | See https://github.com/Kanaries/pygwalker for more information on PyGWalker. 97 | 98 | class parameters: 99 | template_name - template used when rendering page; defaults to: pygwalker/bs5/pygwalker_dynamic.html 100 | theme - PyGWalker theme to use for pyg html; defaults to "media" 101 | title - title used on html render 102 | """ 103 | 104 | template_name: str = "pygwalker/bs5/pygwalker_dynamic.html" 105 | theme: str = getattr(settings, "PYGWALKER_THEME", "media") 106 | title: str = "Upload a csv file" 107 | 108 | def get(self, request): 109 | context = {"form": UploadFileForm(), "title": "Upload a csv file"} 110 | return render(request, self.template_name, context) 111 | 112 | def post(self, request): 113 | context = {} 114 | form = UploadFileForm(request.POST, request.FILES) 115 | if form.is_valid(): 116 | csv_file = form.cleaned_data["csv_file"] 117 | if mimetypes.guess_type(csv_file.name)[0] not in ["text/csv"]: 118 | messages.add_message( 119 | request, messages.ERROR, "file provided is not a csv file", extra_tags="alert-danger" 120 | ) 121 | return render(request, self.template_name, context) 122 | pd_data = pd.read_csv(csv_file) 123 | context["pyg"] = pyg.to_html(pd_data, appearance=self.theme) 124 | context[ 125 | "title" 126 | ] = f"""Showing data from {csv_file.name.split("/")[-1]}""" 127 | return render(request, self.template_name, context) 128 | else: 129 | for error in form.errors: 130 | for i in form.errors[error].data: 131 | for msg in i.messages: 132 | messages.add_message( 133 | self.request, 134 | messages.ERROR, 135 | msg, 136 | extra_tags="alert-danger", 137 | ) 138 | return self.get(request) 139 | 140 | 141 | class GenericPygWalkerView(View): 142 | """View to create a PyGWalker visualization interface from an app and model passed as kwargs. If query 143 | parameters are present, include only filtered data, based on query parameters, in the PyGWalker interface.""" 144 | 145 | field_list: list = [] 146 | queryset: QuerySet = None 147 | template_name: str = "pygwalker/bs5/pygwalker.html" 148 | theme: str = getattr(settings, "PYGWALKER_THEME", "media") 149 | 150 | def get(self, request, **kwargs): 151 | """process GET request""" 152 | referrer = request.META.get("HTTP_REFERER", "") 153 | if "?" in referrer: 154 | query_dict = { 155 | key: value for key, value in (item.split("=") for item in referrer.split("?")[1].split("&") if item) 156 | } 157 | else: 158 | query_dict = {} 159 | model = apps.get_model(kwargs["app_name"], kwargs["model_name"]) 160 | self.queryset = model.objects.filter(**query_dict) 161 | title = f"{self.queryset.model._meta.model_name.title()} Analysis" 162 | pd_data = pd.DataFrame(list(self.queryset.values(*self.field_list))) 163 | if pd_data.empty: 164 | context = {"no_data": f"no {self.queryset.model.__name__} data found", "title": title} 165 | else: 166 | context = {"pyg": pyg.to_html(pd_data, appearance=self.theme), "title": title} 167 | return render(request, self.template_name, context) 168 | 169 | 170 | class PygWalkerListViewMixin: 171 | pygwalker_icon: str = """""" 172 | pygwalker_title: str = "PyGWalker view" 173 | pygwalker_url: str | None = None 174 | 175 | def get(self, request, *args, **kwargs): 176 | if not self.pygwalker_url: 177 | self.pygwalker_url = ( 178 | f"/pygwalker/generic_pyg/{self.queryset.model._meta.app_label}/{self.queryset.model._meta.model_name}" 179 | ) 180 | 181 | self.extra_controls["pygwalker"] = { 182 | "icon": self.pygwalker_icon, 183 | "title": self.pygwalker_title, 184 | "url": self.pygwalker_url, 185 | } 186 | return super().get(request, *args, **kwargs) 187 | 188 | 189 | class PygWalkerListView(PygWalkerListViewMixin, HandyHelperListView): 190 | """extend the HandyHelperListView (from handyhelpers) to add an icon for a PyGWalker 191 | visualzation interface. If the list view is filtered, include only filtered data in the PyGWalker interface.""" 192 | 193 | 194 | class PygWalkerPaginatedListView(PygWalkerListViewMixin, HandyHelperPaginatedListView): 195 | """extend the HandyHelperPaginatedListView (from handyhelpers) to add an icon for a PyGWalker 196 | visualzation interface. If the list view is filtered, include only filtered data in the PyGWalker interface.""" 197 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | import django 4 | 5 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.core.settings") 6 | django.setup() 7 | -------------------------------------------------------------------------------- /tests/core/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/tests/core/__init__.py -------------------------------------------------------------------------------- /tests/core/settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Minimal file for unittest configs. 3 | """ 4 | import os 5 | from pathlib import Path 6 | 7 | BASE_DIR = Path(__file__).resolve().parent.parent 8 | 9 | 10 | SECRET_KEY = "test" 11 | 12 | # INSTALLED_APPS with these apps is necessary for Sphinx to build 13 | # without warnings & errors 14 | # Depending on your package, the list of apps may be different 15 | INSTALLED_APPS = [ 16 | "django.contrib.auth", 17 | "django.contrib.contenttypes", 18 | "djangoaddicts.pygwalker", 19 | "handyhelpers", 20 | "tests.core.testapp", 21 | ] 22 | 23 | MIDDLEWARE = [ 24 | "django.middleware.security.SecurityMiddleware", 25 | "django.contrib.sessions.middleware.SessionMiddleware", 26 | "django.middleware.common.CommonMiddleware", 27 | "django.middleware.csrf.CsrfViewMiddleware", 28 | "django.contrib.auth.middleware.AuthenticationMiddleware", 29 | "django.contrib.messages.middleware.MessageMiddleware", 30 | "django.middleware.clickjacking.XFrameOptionsMiddleware", 31 | ] 32 | 33 | ROOT_URLCONF = "tests.core.urls" 34 | 35 | DATABASES = { 36 | "default": { 37 | "ENGINE": "django.db.backends.sqlite3", 38 | "NAME": "db.sqlite3", 39 | "TEST_NAME": "test.sqlite3", 40 | "USER": "djangoaddicts", 41 | "PASSWORD": "djangoaddicts", 42 | } 43 | } 44 | 45 | TEMPLATES = [ 46 | { 47 | "BACKEND": "django.template.backends.django.DjangoTemplates", 48 | "DIRS": [os.path.join(BASE_DIR, "core", "templates")], 49 | "APP_DIRS": True, 50 | "OPTIONS": { 51 | "context_processors": [ 52 | "django.template.context_processors.debug", 53 | "django.template.context_processors.request", 54 | "django.contrib.auth.context_processors.auth", 55 | "django.contrib.messages.context_processors.messages", 56 | ], 57 | }, 58 | }, 59 | ] 60 | 61 | BASE_TEMPLATE = "base.htm" 62 | 63 | USE_TZ = True 64 | -------------------------------------------------------------------------------- /tests/core/templates/base.htm: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/tests/core/templates/base.htm -------------------------------------------------------------------------------- /tests/core/testapp/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/tests/core/testapp/__init__.py -------------------------------------------------------------------------------- /tests/core/testapp/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class TestappConfig(AppConfig): 5 | default_auto_field = "django.db.models.BigAutoField" 6 | name = "tests.core.testapp" 7 | -------------------------------------------------------------------------------- /tests/core/testapp/forms.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | 3 | 4 | class TestForm(forms.Form): 5 | pass 6 | -------------------------------------------------------------------------------- /tests/core/testapp/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | from django.db import migrations, models 2 | 3 | 4 | class Migration(migrations.Migration): 5 | initial = True 6 | 7 | dependencies = [] 8 | 9 | operations = [ 10 | migrations.CreateModel( 11 | name="TestModel", 12 | fields=[ 13 | ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")), 14 | ("name", models.CharField(max_length=8)), 15 | ], 16 | ), 17 | ] 18 | -------------------------------------------------------------------------------- /tests/core/testapp/migrations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/tests/core/testapp/migrations/__init__.py -------------------------------------------------------------------------------- /tests/core/testapp/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | 4 | class TestModel(models.Model): 5 | name = models.CharField(max_length=8) 6 | -------------------------------------------------------------------------------- /tests/core/testapp/templates/testapp/my_custom_template.html: -------------------------------------------------------------------------------- 1 | {{ pyg|safe }} 2 | -------------------------------------------------------------------------------- /tests/core/testapp/views.py: -------------------------------------------------------------------------------- 1 | from djangoaddicts.pygwalker.views import ( 2 | PygWalkerListView, 3 | PygWalkerPaginatedListView, 4 | PygWalkerView, 5 | StaticCsvPygWalkerView, 6 | ) 7 | from tests.core.testapp.models import TestModel 8 | 9 | 10 | class BasicPygWalkerView(PygWalkerView): 11 | queryset = TestModel.objects.all() 12 | 13 | 14 | class CustomTitlePygWalkerView(PygWalkerView): 15 | queryset = TestModel.objects.all() 16 | title = "My Custom Title" 17 | 18 | 19 | class ExplicitFieldsPygWalkerView(PygWalkerView): 20 | queryset = TestModel.objects.all() 21 | title = "TestModel Data Analysis" 22 | theme = "light" 23 | field_list = ["name"] 24 | 25 | 26 | class CustomTemplatePygWalkerView(PygWalkerView): 27 | queryset = TestModel.objects.all() 28 | template_name = "testapp/my_custom_template.html" 29 | 30 | 31 | class BasicStaticCsvPygWalkerViewView(StaticCsvPygWalkerView): 32 | csv_file = "tests/data/data.csv" 33 | 34 | 35 | class CustomTemplateStaticCsvPygWalkerViewView(StaticCsvPygWalkerView): 36 | csv_file = "tests/data/data.csv" 37 | template_name = "testapp/my_custom_template.html" 38 | 39 | 40 | class TestModelListView(PygWalkerListView): 41 | queryset = TestModel.objects.all() 42 | title = "TestModels" 43 | 44 | 45 | class TestModelPaginatedListView(PygWalkerPaginatedListView): 46 | queryset = TestModel.objects.all() 47 | title = "TestModels" 48 | -------------------------------------------------------------------------------- /tests/core/urls.py: -------------------------------------------------------------------------------- 1 | from django.urls import path, include 2 | 3 | from tests.core.testapp.views import ( 4 | BasicPygWalkerView, 5 | BasicStaticCsvPygWalkerViewView, 6 | CustomTitlePygWalkerView, 7 | CustomTemplatePygWalkerView, 8 | CustomTemplateStaticCsvPygWalkerViewView, 9 | ExplicitFieldsPygWalkerView, 10 | TestModelListView, 11 | TestModelPaginatedListView, 12 | ) 13 | 14 | urlpatterns = [ 15 | path("basic/", BasicPygWalkerView.as_view(), name="basic"), 16 | path("custom_title/", CustomTitlePygWalkerView.as_view(), name="custom_title"), 17 | path("explicit/", ExplicitFieldsPygWalkerView.as_view(), name="explicit"), 18 | path("custom/", CustomTemplatePygWalkerView.as_view(), name="custom"), 19 | path("static_basic/", BasicStaticCsvPygWalkerViewView.as_view(), name="static_basic"), 20 | path("static_custom/", CustomTemplateStaticCsvPygWalkerViewView.as_view(), name="static_custom"), 21 | path("test_model_list_view/", TestModelListView.as_view(), name="test_model_list_view"), 22 | path( 23 | "test_model_paginated_list_view/", TestModelPaginatedListView.as_view(), name="test_model_paginated_list_view" 24 | ), 25 | path("pygwalker/", include("djangoaddicts.pygwalker.urls")), 26 | ] 27 | -------------------------------------------------------------------------------- /tests/data/blank: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/tests/data/blank -------------------------------------------------------------------------------- /tests/data/data.csv: -------------------------------------------------------------------------------- 1 | Name,Age,City,Salary,Date 2 | Person_1,42,Chicago,50754,1983-03-13 3 | Person_2,31,Los Angeles,89511,1983-04-19 4 | Person_3,26,Chicago,77705,2004-11-14 5 | Person_4,43,Los Angeles,54225,1996-09-15 6 | Person_5,25,Chicago,61892,1980-08-18 7 | Person_6,35,Chicago,40911,2007-03-22 8 | Person_7,48,San Francisco,73516,2014-01-26 9 | Person_8,37,New York,78823,1997-06-16 10 | Person_9,35,New York,81352,1981-11-28 11 | Person_10,31,Los Angeles,48646,2008-10-28 12 | Person_11,36,Seattle,43934,2018-10-19 13 | Person_12,26,San Francisco,73641,1992-08-29 14 | Person_13,22,San Francisco,84591,1993-06-07 15 | Person_14,45,New York,56018,2000-07-13 16 | Person_15,50,San Francisco,98653,1993-12-01 17 | Person_16,45,Los Angeles,87137,1989-02-21 18 | Person_17,23,Los Angeles,41793,2006-09-30 19 | Person_18,45,New York,89548,2014-03-18 20 | Person_19,50,Seattle,44938,2001-03-01 21 | Person_20,37,San Francisco,51237,1988-10-30 22 | Person_21,43,New York,85706,1997-07-18 23 | Person_22,41,San Francisco,74812,2007-04-13 24 | Person_23,48,Los Angeles,75169,1993-02-26 25 | Person_24,22,Seattle,49686,1987-03-29 26 | Person_25,42,New York,60213,1990-04-29 27 | Person_26,35,New York,46395,2016-01-03 28 | Person_27,40,Chicago,79998,1997-12-22 29 | Person_28,43,San Francisco,91895,2009-09-13 30 | Person_29,44,Los Angeles,52409,1990-07-10 31 | Person_30,28,Seattle,55245,2000-09-13 32 | Person_31,33,New York,57186,1992-12-07 33 | Person_32,23,New York,97908,2015-09-13 34 | Person_33,50,Chicago,76029,1985-06-16 35 | Person_34,33,Chicago,60437,1981-11-22 36 | Person_35,27,Los Angeles,45093,2005-06-16 37 | Person_36,35,Chicago,62306,2010-10-26 38 | Person_37,50,San Francisco,47688,2000-07-01 39 | Person_38,25,New York,99312,1991-04-03 40 | Person_39,39,Seattle,92942,2003-12-25 41 | Person_40,31,Los Angeles,42490,1997-02-19 42 | Person_41,32,San Francisco,42020,1988-12-26 43 | Person_42,40,New York,81988,1981-07-01 44 | Person_43,34,San Francisco,96498,2018-04-17 45 | Person_44,31,Seattle,40405,1984-09-03 46 | Person_45,48,San Francisco,65046,2003-05-27 47 | Person_46,37,Chicago,58297,1991-06-16 48 | Person_47,30,Seattle,44971,1997-08-12 49 | Person_48,23,Los Angeles,83651,2017-01-17 50 | Person_49,32,Seattle,42406,2000-10-13 51 | Person_50,37,New York,44543,2012-06-26 52 | -------------------------------------------------------------------------------- /tests/data/invalid: -------------------------------------------------------------------------------- 1 | this is an invalid csv file -------------------------------------------------------------------------------- /tests/unit/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/djangoaddicts/django-pygwalker/897cedbc0480534a2ecb8d218a3d5571ca2be558/tests/unit/__init__.py -------------------------------------------------------------------------------- /tests/unit/test_views.py: -------------------------------------------------------------------------------- 1 | from django.shortcuts import reverse 2 | from django.test import RequestFactory, TestCase 3 | 4 | from djangoaddicts.pygwalker.views import ( 5 | PygWalkerView, 6 | StaticCsvPygWalkerView, 7 | PygWalkerListView, 8 | PygWalkerPaginatedListView, 9 | ) 10 | from tests.core.testapp.forms import TestForm 11 | from tests.core.testapp.models import TestModel 12 | from model_bakery import baker 13 | 14 | 15 | class PygWalkerViewCallTests(TestCase): 16 | """test PygWalkerView view""" 17 | 18 | class MyPygWalkerView(PygWalkerView): 19 | queryset = TestModel.objects.none() 20 | 21 | def setUp(self) -> None: 22 | self.factory = RequestFactory() 23 | self.request = self.factory.get("") 24 | return super().setUp() 25 | 26 | def test_view(self) -> None: 27 | """verify PygWalkerView is called""" 28 | response = self.MyPygWalkerView.as_view()(self.request) 29 | self.assertEqual(response.status_code, 200) 30 | 31 | 32 | class StaticCsvPygWalkerViewCallTests(TestCase): 33 | """test StaticCsvPygWalkerView view""" 34 | 35 | class MyPygWalkerView(StaticCsvPygWalkerView): 36 | csv_file = "tests/data/data.csv" 37 | 38 | def setUp(self) -> None: 39 | self.factory = RequestFactory() 40 | self.request = self.factory.get("") 41 | return super().setUp() 42 | 43 | def test_view(self) -> None: 44 | """verify StaticCsvPygWalkerView is called""" 45 | response = self.MyPygWalkerView.as_view()(self.request) 46 | self.assertEqual(response.status_code, 200) 47 | 48 | 49 | class PygWalkerViewUsageTests(TestCase): 50 | def test_basic(self): 51 | baker.make("testapp.TestModel") 52 | url = reverse("basic") 53 | response = self.client.get(url) 54 | self.assertEqual(response.status_code, 200) 55 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 56 | 57 | def test_basic_no_data(self): 58 | url = reverse("basic") 59 | response = self.client.get(url) 60 | self.assertEqual(response.status_code, 200) 61 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 62 | 63 | def test_custom_template(self): 64 | baker.make("testapp.TestModel") 65 | url = reverse("custom") 66 | response = self.client.get(url) 67 | self.assertEqual(response.status_code, 200) 68 | self.assertTemplateUsed(response, "testapp/my_custom_template.html") 69 | self.assertTemplateNotUsed(response, "pygwalker/bs5/pygwalker.html") 70 | 71 | def test_explicit_fields(self): 72 | baker.make("testapp.TestModel") 73 | url = reverse("explicit") 74 | response = self.client.get(url) 75 | self.assertEqual(response.status_code, 200) 76 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 77 | 78 | def test_custom_title(self): 79 | baker.make("testapp.TestModel") 80 | url = reverse("custom_title") 81 | response = self.client.get(url) 82 | self.assertEqual(response.status_code, 200) 83 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 84 | 85 | def test_with_referrer(self): 86 | baker.make("testapp.TestModel") 87 | url = reverse("basic") 88 | response = self.client.get(url, HTTP_REFERER="/?name=blah") 89 | self.assertEqual(response.status_code, 200) 90 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 91 | 92 | 93 | class StaticCsvPygWalkerViewUsageTests(TestCase): 94 | def test_basic(self): 95 | url = reverse("static_basic") 96 | response = self.client.get(url) 97 | self.assertEqual(response.status_code, 200) 98 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 99 | 100 | def test_custom_template(self): 101 | url = reverse("static_custom") 102 | response = self.client.get(url) 103 | self.assertEqual(response.status_code, 200) 104 | self.assertTemplateUsed(response, "testapp/my_custom_template.html") 105 | self.assertTemplateNotUsed(response, "pygwalker/bs5/pygwalker.html") 106 | 107 | 108 | class DynamicCsvPygWalkerTests(TestCase): 109 | """test DynamicCsvPygWalker view""" 110 | 111 | def test_get(self): 112 | url = reverse("pygwalker:") 113 | response = self.client.get(url) 114 | self.assertEqual(response.status_code, 200) 115 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker_dynamic.html") 116 | 117 | def test_post(self): 118 | url = reverse("pygwalker:") 119 | with open("./tests/data/data.csv") as csv_file: 120 | response = self.client.post(url, data={"csv_file": csv_file}) 121 | self.assertEqual(response.status_code, 200) 122 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker_dynamic.html") 123 | 124 | def test_post_invalid_file(self): 125 | url = reverse("pygwalker:") 126 | with open("./tests/data/invalid") as csv_file: 127 | response = self.client.post(url, data={"csv_file": csv_file}) 128 | self.assertEqual(response.status_code, 200) 129 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker_dynamic.html") 130 | 131 | def test_post_blank_file(self): 132 | url = reverse("pygwalker:") 133 | with open("./tests/data/blank") as csv_file: 134 | response = self.client.post(url, data={"csv_file": csv_file}) 135 | self.assertEqual(response.status_code, 200) 136 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker_dynamic.html") 137 | 138 | 139 | class GenericPygWalkerTests(TestCase): 140 | """test GenericPygWalkerTests view""" 141 | 142 | def test_get(self): 143 | baker.make("testapp.TestModel") 144 | url = reverse("pygwalker:generic_pyg", kwargs={"app_name": "testapp", "model_name": "testmodel"}) 145 | response = self.client.get(url) 146 | self.assertTrue(True) 147 | self.assertEqual(response.status_code, 200) 148 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 149 | 150 | def test_get_with_referrer(self): 151 | baker.make("testapp.TestModel") 152 | url = reverse("pygwalker:generic_pyg", kwargs={"app_name": "testapp", "model_name": "testmodel"}) 153 | response = self.client.get(url, **{"HTTP_REFERER": "/home?name=blah"}) 154 | self.assertTrue(True) 155 | self.assertEqual(response.status_code, 200) 156 | self.assertTemplateUsed(response, "pygwalker/bs5/pygwalker.html") 157 | 158 | 159 | class PygWalkerListViewCallTests(TestCase): 160 | """test PygWalkerListView view""" 161 | 162 | class MyPygWalkerListView(PygWalkerListView): 163 | queryset = TestModel.objects.none() 164 | pygwalker_url = f"/pygwalker/generic_pyg/{queryset.model._meta.app_label}/{queryset.model._meta.model_name}" 165 | filter_form_obj = TestForm 166 | create_form_obj = TestForm 167 | 168 | class MyPygWalkerListViewNoUrl(PygWalkerListView): 169 | queryset = TestModel.objects.none() 170 | 171 | def setUp(self) -> None: 172 | self.factory = RequestFactory() 173 | self.request = self.factory.get("") 174 | return super().setUp() 175 | 176 | def test_view(self) -> None: 177 | """verify PygWalkerListView is called""" 178 | response = self.MyPygWalkerListView.as_view()(self.request) 179 | self.assertEqual(response.status_code, 200) 180 | 181 | def test_view_no_url(self) -> None: 182 | """verify PygWalkerListView is called""" 183 | response = self.MyPygWalkerListViewNoUrl.as_view()(self.request) 184 | self.assertEqual(response.status_code, 200) 185 | 186 | 187 | class PygWalkerListViewUsageTests(TestCase): 188 | def test_basic(self): 189 | url = reverse("test_model_list_view") 190 | response = self.client.get(url) 191 | self.assertEqual(response.status_code, 200) 192 | self.assertTemplateUsed(response, "handyhelpers/generic/bs5/generic_list.html") 193 | 194 | 195 | class PygWalkerPaginatedListViewCallTests(TestCase): 196 | """test PygWalkerPaginatedListView view""" 197 | 198 | class MyPygWalkerPaginatedListView(PygWalkerPaginatedListView): 199 | queryset = TestModel.objects.none() 200 | pygwalker_url = f"/pygwalker/generic_pyg/{queryset.model._meta.app_label}/{queryset.model._meta.model_name}" 201 | filter_form_obj = TestForm 202 | create_form_obj = TestForm 203 | 204 | class MyPygWalkerPaginatedListViewNoUrl(PygWalkerPaginatedListView): 205 | queryset = TestModel.objects.none() 206 | 207 | def setUp(self) -> None: 208 | self.factory = RequestFactory() 209 | self.request = self.factory.get("") 210 | return super().setUp() 211 | 212 | def test_view(self) -> None: 213 | """verify PygWalkerListView is called""" 214 | response = self.MyPygWalkerPaginatedListView.as_view()(self.request) 215 | self.assertEqual(response.status_code, 200) 216 | 217 | def test_view_no_url(self) -> None: 218 | """verify PygWalkerListView is called""" 219 | response = self.MyPygWalkerPaginatedListViewNoUrl.as_view()(self.request) 220 | self.assertEqual(response.status_code, 200) 221 | 222 | 223 | class PygWalkerPaginatedListViewUsageTests(TestCase): 224 | def test_basic(self): 225 | url = reverse("test_model_paginated_list_view") 226 | response = self.client.get(url) 227 | self.assertEqual(response.status_code, 200) 228 | self.assertTemplateUsed(response, "handyhelpers/generic/bs5/generic_list.html") 229 | --------------------------------------------------------------------------------