Metadata-Version: 2.1
Name: ievv-opensource
Version: 9.1.0
Summary: The opensource modules from the commercial IEVV Django framework.
Author: Tor Johansen, Magne Westlie
Author-email: Espen Angell Kristiansen <post@appresso.no>
License: Copyright (c) 2015, Appresso AS
        All rights reserved. 
        
        Redistribution and use in source and binary forms, with or without 
        modification, are permitted provided that the following conditions are met: 
        
         * Redistributions of source code must retain the above copyright notice, 
           this list of conditions and the following disclaimer. 
         * Redistributions in binary form must reproduce the above copyright 
           notice, this list of conditions and the following disclaimer in the 
           documentation and/or other materials provided with the distribution. 
         * Neither the name of Appresso AS nor the names of its contributors may be 
           used to endorse or promote products derived from this software without 
           specific prior written permission. 
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
        POSSIBILITY OF SUCH DAMAGE. 
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.8.0
Requires-Dist: arrow
Requires-Dist: django<5.0.0,>=4.0.0
Requires-Dist: psutil
Requires-Dist: sh
Requires-Dist: termcolor
Requires-Dist: watchdog
Provides-Extra: dev
Requires-Dist: autopep8; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: htmls; extra == 'dev'
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: model-bakery; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-django; extra == 'dev'
Requires-Dist: pytest-env; extra == 'dev'
Requires-Dist: tox; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: optional
Requires-Dist: arrow; extra == 'optional'
Requires-Dist: django-rq; extra == 'optional'
Requires-Dist: djangorestframework; extra == 'optional'
Requires-Dist: gsm0338; extra == 'optional'
Requires-Dist: psutil; extra == 'optional'
Requires-Dist: psycopg2; extra == 'optional'
Requires-Dist: redis; extra == 'optional'
Requires-Dist: rq; extra == 'optional'
Requires-Dist: sh; extra == 'optional'
Requires-Dist: termcolor; extra == 'optional'
Requires-Dist: watchdog; extra == 'optional'
Description-Content-Type: text/markdown

# ievv_opensource

## Develop
Requires:
- https://github.com/pyenv/pyenv
- Docker (Docker desktop or similar)


### Install for development

Install a local python version with pyenv:
```
$ pyenv install 3.10
$ pyenv local 3.10
```

Install dependencies in a virtualenv:
```
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install ".[dev,optional]"
```

### Run postgres and redis
```
$ docker-compose up
```

### Run dev server
```
$ source .venv/bin/activate   # enable virtualenv
$ ievv devrun -n docker-compose
```

### Run tests
```
$ source .venv/bin/activate   # enable virtualenv
$ pytest
```


### Destroy postgres and redis
```
$ docker-compose down -v
```


## Documentation
http://ievv-opensource.readthedocs.org/


## How to release ievv_opensource
1. Update version using `hatch version`:
   ```
   Major version update:
   $ hatch version major
   
   Minor version update:
   $ hatch version minor
   
   Patch version update:
   $ hatch version patch
   ```
2. Add releasenote to releasenotes folder on root with name `releasenotes-<major-version>.md`.
3. Commit with ``Release <version>``.
4. Tag the commit with ``<version>``.
5. Push (``git push && git push --tags``).
6. Release to pypi:
   ```
   $ hatch build -t sdist
   $ hatch publish
   ```
