Metadata-Version: 2.1
Name: devilry
Version: 6.3.0rc5
Summary: A system for handling electronic deliveries. See https://github.com/devilry/devilry-django.
Author: Tor Johansen, Bendik Opstad, Vegard Angell, Magne Westlie, Ilya Kostolomov, Christian Tryti, Rebekka Mørken, Stian Julseth
Author-email: Espen Angell Kristiansen <post@appresso.no>
License: Copyright (c) 2010, Devilry contributors
        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 the Devilry contributors 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 COPYRIGHT OWNERS 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.9.0
Requires-Dist: arrow<0.13.0,>=0.12.0
Requires-Dist: chardet<3.1.0,>=3.0.0
Requires-Dist: cradmin-legacy<6.0.0,>=5.0.0
Requires-Dist: detektor==1.1.0-beta.012
Requires-Dist: dj-database-url<0.4.0,>=0.3.0
Requires-Dist: dj-static<0.1.0,>=0.0.0
Requires-Dist: django-allauth>=0.57.0
Requires-Dist: django-cradmin<11.0.0,>=10.3.3
Requires-Dist: django-crispy-forms<1.15.0,>=1.14.0
Requires-Dist: django-rq<2.5.0,>=2.4.0
Requires-Dist: django<4.3.0,>=4.2.0
Requires-Dist: djangorestframework
Requires-Dist: flup<1.1.0,>=1.0.0
Requires-Dist: gunicorn<22,>=21.2.0
Requires-Dist: html-sanitizer
Requires-Dist: html2text<2018.2.0,>=2018.1.0
Requires-Dist: html5lib
Requires-Dist: httplib2<0.20.0,>=0.19.0
Requires-Dist: idna<2.7.0,>=2.6.0
Requires-Dist: ievv-opensource<10.0.0,>=9.2.2
Requires-Dist: markdown<3.4.0,>=3.3.0
Requires-Dist: mimeparse<0.2.0,>=0.1.0
Requires-Dist: numpy
Requires-Dist: oauthlib<2.1.0,>=2.0.0
Requires-Dist: openpyxl
Requires-Dist: psycopg2
Requires-Dist: pycountry<17.10.0,>=17.9.0
Requires-Dist: pygments<2.16.0,>=2.15.0
Requires-Dist: python-dateutil<2.9.0,>=2.8.0
Requires-Dist: python-openid<2.3.0,>=2.2.0
Requires-Dist: pytz<2018.10.0,>=2018.9.0
Requires-Dist: pyyaml==6.0.1
Requires-Dist: redis<3.6.0,>=3.5.0
Requires-Dist: requests
Requires-Dist: requests-oauthlib<0.9.0,>=0.8.0
Requires-Dist: rq<1.9.0,>=1.8.0
Requires-Dist: six<1.16.0,>=1.15.0
Requires-Dist: stream-zip>=0.0.70
Requires-Dist: to-file-like-obj>=0.0.5
Requires-Dist: urllib3>=1.26.0
Requires-Dist: urlobject<2.5.0,>=2.4.0
Requires-Dist: xlsxwriter<1.2.0,>=1.1.0
Provides-Extra: dev
Requires-Dist: beautifulsoup4==4.7.1; extra == 'dev'
Requires-Dist: boto==2.32.1; extra == 'dev'
Requires-Dist: django-auth-ldap; extra == 'dev'
Requires-Dist: django-debug-toolbar; extra == 'dev'
Requires-Dist: django-silk; extra == 'dev'
Requires-Dist: django-storages==1.1.5; extra == 'dev'
Requires-Dist: doc2dash==3.0.0; extra == 'dev'
Requires-Dist: fabric3==1.14.post1; extra == 'dev'
Requires-Dist: flake8==2.2.2; extra == 'dev'
Requires-Dist: htmls==1.0.0; extra == 'dev'
Requires-Dist: model-bakery; extra == 'dev'
Requires-Dist: pip-tools; extra == 'dev'
Requires-Dist: pyflakes==0.8.1; extra == 'dev'
Requires-Dist: sphinx-rtd-theme==1.2.2; extra == 'dev'
Requires-Dist: sphinx==6.2.1; extra == 'dev'
Requires-Dist: tox==1.7.2; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: htmls; extra == 'test'
Requires-Dist: mock==3.0.5; extra == 'test'
Requires-Dist: model-bakery; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Requires-Dist: pytest-env; extra == 'test'
Description-Content-Type: text/markdown

# devilry

## Develop

Requires:

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

### Use conventional commits for GIT commit messages

See https://www.conventionalcommits.org/en/v1.0.0/.
You can use this git commit message format in many different ways, but the easiest is:

- Use commitizen: https://commitizen-tools.github.io/commitizen/commit/
- Use an editor extension, like https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits for VScode.
- Just learn to write the format by hand (can be error prone to begin with, but it is fairly easy to learn).

### Install hatch and commitizen

NOTE: You only need hatch if you need to build releases, and you
only need commitizen for releases OR to make it easy to follow
conventional commits for your commit messages
(see _Use conventional commits for GIT commit messages_ above).

First install pipx with:

```
$ brew install pipx
$ pipx ensurepath
```

Then install hatch and commitizen:

```
$ pipx install hatch
$ pipx install commitizen
```

See https://github.com/pypa/pipx, https://hatch.pypa.io/latest/install/
and https://commitizen-tools.github.io/commitizen/ for more install alternatives if
needed, but we really recommend using pipx since that is isolated.

### Install development dependencies

#### Install a local python version with pyenv:

```
$ pyenv install 3.10
$ pyenv local 3.10
```

#### Install dependencies in a virtualenv:

```
$ ./recreate-virtualenv.sh
```

Alternatively, create virtualenv manually (this does the same as recreate-virtualenv.sh):

```
$ python -m venv .venv
```

the ./recreate-virtualenv.sh script is just here to make creating virtualenvs more uniform
across different repos because some repos will require extra setup in the virtualenv
for package authentication etc.

#### Install dependencies in a virtualenv:

```
$ source .venv/bin/activate   # enable virtualenv
$ pip install -e ".[dev,test]"
```

### Upgrade your local packages

This will upgrade all local packages according to the constraints
set in pyproject.toml:

```
$ pip install --upgrade --upgrade-strategy=eager ".[dev,test]"
```

### Run postgres and redis

```
$ docker-compose up
```

### Run dev server

```
$ source .venv/bin/activate   # enable virtualenv
$ ievv devrun
```

### Create or re-create a devdatabase
You should always clear the database before recreating it. The easiest way is just to clear the docker resources (and volumes) and start it again.
```
$ docker-compose down -v
$ docker-compose up
```

Run dev server (in a new terminal)
```
$ source .venv/bin/activate   # activate virtualenv
$ ievv devrun
```

Load devdatabase SQL-file (in a new terminal)
```
$ source .venv/bin/activate   # activate virtualenv
$ docker-compose exec -T postgres psql -U dbdev --dbname=dbdev -p 5432 -h localhost < devilry/project/develop/dumps/default.sql
$ python manage.py migrate
$ ievv customsql -i -r
```

If the dump should be updated for e.g new migrations, run the following and commit to repo:
```
$ docker-compose exec -T postgres pg_dump --clean --no-owner --no-acl --no-privileges -U dbdev -h localhost -p 5432 dbdev > devilry/project/develop/dumps/default.sql
```

### Run tests

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

### Build css/javascript:
```
$ source .venv/bin/activate   # activate virtualenv
$ nvm use 14    # May need to run "nvm install 14" first
$ ievv buildstatic
... or if you want to watch for changes ...:
$ ievv buildstatic --watch
```

To remove and reinstall all node-packages:
```
$ source .venv/bin/activate   # activate virtualenv
$ nvm use 14    # May need to run "nvm install 14" first
$ ievv buildstatic --npm-clean-node-modules
```

### Destroy postgres and redis

```
$ docker-compose down -v
```

## Documentation

https://devilry.readthedocs.io

## Release

### Translations

To translate new texts, do the following:

- ``ievv makemessages``
- Translate the .po files. Poedit is a great tool for this.
- ``ievv compilemessages``
- Commit the changes

### Set version and build staticfiles

First make sure you have NO UNCOMITTED CHANGES!

Release (create changelog, increment version, build staticfiles, commit and tag the change) with:

```bash
$ nvm use 14
$ tools/release/prepare-release.py prepare --apply  # This will bump the version and then build and commit staticfiles.
$ git push && git push --tags
```

### NOTE (release):

- `cz bump` automatically updates CHANGELOG.md, updates version file(s), commits the change and tags the release commit.
- If you are unsure about what `cz bump` will do, run it with `--dry-run`. You can use
  options to force a specific version instead of the one it automatically selects
  from the git log if needed, BUT if this is needed, it is a sign that someone has messed
  up with their conventional commits.
- `cz bump` only works if conventional commits (see section about that above) is used.
- `cz bump` can take a specific version etc, but it automatically select the correct version
  if conventional commits has been used correctly. See https://commitizen-tools.github.io/commitizen/.
- If you need to add more to CHANGELOG.md (migration guide, etc), you can just edit
  CHANGELOG.md after the release, and commit the change with a `docs: some useful message`
  commit.
- The `cz` command comes from `commitizen` (install documented above).

### What if the release fails?

See _How to revert a bump_ in the [commitizen FAQ](https://commitizen-tools.github.io/commitizen/faq/#how-to-revert-a-bump).


### Migrationguide and changelog (for official readthedocs)
- Add a migration guide to not_for_deploy/docs/sysadmin/migrationguides/
- Add a changelog to not_for_deploy/docs/user/changelog/

### Release to pypi:

```bash
$ hatch build -t sdist
$ hatch publish
$ rm dist/*              # optional cleanup
```
