Metadata-Version: 2.4
Name: NEMO-reports
Version: 2.1.5
Summary: Reports plugin for NEMO
Author-email: Atlantis Labs LLC <atlantis@atlantislabs.io>
License: MIT License
        
        Copyright (c) 2023 Atlantis Labs LLC
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/nemo-community/atlantis-labs/nemo-reports
Project-URL: Changelog, https://gitlab.com/nemo-community/atlantis-labs/nemo-reports/-/releases
Project-URL: Issues, https://gitlab.com/nemo-community/atlantis-labs/nemo-reports/-/issues
Project-URL: CI, https://gitlab.com/nemo-community/atlantis-labs/nemo-reports/-/pipelines
Keywords: NEMO
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Django :: 4.2
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django
Requires-Dist: python-dateutil
Provides-Extra: nemo-ce
Requires-Dist: NEMO-CE>=7.0.0; extra == "nemo-ce"
Provides-Extra: nemo
Requires-Dist: NEMO>=7.0.0; extra == "nemo"
Provides-Extra: dev-tools
Requires-Dist: pre-commit; extra == "dev-tools"
Requires-Dist: djlint; extra == "dev-tools"
Requires-Dist: black; extra == "dev-tools"
Dynamic: license-file

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/NEMO-Reports?label=python)](https://www.python.org/downloads/release/python-3110/)
[![PyPI](https://img.shields.io/pypi/v/nemo-reports?label=pypi%20version)](https://pypi.org/project/NEMO-Reports/)

# NEMO Reports

This plugin for NEMO adds a variety of reports.

# Compatibility:

NEMO/NEMO-CE >= 7.0.0 ----> NEMO-Reports >= 2.0.0

NEMO >= 4.5.0 ----> NEMO-Reports >= 1.6.0

NEMO >= 4.3.0 ----> NEMO-Reports >= 1.0.0

# Installation

`pip install NEMO-reports[NEMO]`

# Add NEMO Reports

in `settings.py` add to `INSTALLED_APPS`:

```python
INSTALLED_APPS = [
    '...',
    'NEMO_reports', # This needs to be before NEMO_billing (if installed) and NEMO
    '...'
    'NEMO_billing', # Optional
    '...'
    'NEMO',
    '...'
]
```

# Usage
Simply navigate to the `Reports` page in the `Administration` menu.

For non-administrator users, permissions are given per report, via `Detailed administration -> Users` (search for "report" in the permissions list)

## Options
Some options are available in `Customization -> Reports`:

* First day of the week (Sunday/Monday)
* Default report date range
* Excluding projects from report data
* Display format for duration
