Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

freeze of packages, instructions for developers #87

Merged
merged 1 commit into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Issue addressed
Fixes #<issue number>

## Explanation
Explain how you addressed the bug/feature request, what choices you made and why.

## General Checklist
- [ ] Updated tests or added new tests
- [ ] Fork is up-to-date with `main`
- [ ] Tests pass
- [ ] Updated documentation
- [ ] Updated changelog.rst

## Additional Notes (optional)
Add any additional notes or information that may be helpful.
1 change: 0 additions & 1 deletion LiveORC/celery.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
from __future__ import absolute_import, unicode_literals
import os
from celery import Celery
import nodeorc

# Set the default Django settings module for the 'celery' program.
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'LiveORC.settings')
Expand Down
1 change: 0 additions & 1 deletion api/admin/device.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ def has_delete_permission(self, request, obj=None):
return True
return False


form = DeviceForm
# list_filter = [TaskInstituteFilter]
#
Expand Down
59 changes: 59 additions & 0 deletions dev/DEVELOP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Developer instructions

## Rights
The [AGPL-3.0 license](https://github.com/localdevices/LiveORC/blob/main/LICENSE) applies to all contributions made to
this project. By contributing you agree to these license
terms.

## Reporting issues
LiveORC is a highly active and new project. Therefore, we welcome reports of bugs, problems with features, and even
suggestions for new features, ideally with opportunities to get their implementation funded. However, before
submitting an issue, first assess existing, open and closed issues, before creating a new one.

For reports of bugs, please run liveorc in debug mode using `--debug` as additional option in the `./liveorc.sh`
launching script and provide tracebacks. Minimal reproducible examples with data may be very helpful if there is an
issue with video files.

## Checklist for pull requests

If you wish to fix a bug or implement a feature, please make sure to go through the following steps:

1. If it does not yet exist, create an issue following the template. We highly recommend to first await a discussion
with a localdevices team member before you start developing.
2. Create a fork of the code where you develop your improvements.
3. Update `dev/CHANGELOG.md` with a summary of your changes and a link to your pull request.
4. Push your commits to your fork and open a draft pull request. Please fill in the pre-filled template with all
relevant information. Update your pull request if needed to complete the checklist.
5. Once you are satisfied with the changes mark the pull as "ready for review". A localdevices team member will
review your contributions and may request improvements.
6. Once the review is accepted, the localdevices team member will merge your contributions in the main branch.

## Release checklist

Before creating a new release, the following MUST be in place.

- Bump version number (minor: fixes and bugs, medium: small changes in API, added features, major: large breaking
changes or major new options and features)
- Updated CHANGELOG.md
- ensure any new requirements are added to `dev/requirements.txt` without a version number (unless a specific
version is required).
- freeze `requirements.txt` as instructed below

## How to freeze packages

This requires a clean setup of the entire environment as follows:

```shell
# create and activate a fresh venv
python -m venv $HOME/venv/liveorc-dev
source $HOME/venv/liveorc-dev/bin/activate
pip install --upgrade pip
pip install -r dev/requirements.txt
# freeze only packages directly imported into the project
pip freeze -q -r dev/requirements.txt | sed '/freeze/,$ d' > requirements.txt
deactivate
# remove temporarily created venv
rm -fr $HOME/venv/liveorc-dev

```

23 changes: 23 additions & 0 deletions dev/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
celery
cryptography
django
djangorestframework
djangorestframework-csv
djangorestframework-queryfields
djangorestframework-simplejwt
django-admin-rangefilter
django-admin-interface
django-debug-toolbar
django-extensions
django-filter
django-import-export
django-json-widget
django-object-actions
django-storages
drf-nested-routers
drf-spectacular
fontawesomefree
nodeorc==0.1.7
pytest-django
psycopg2-binary
shortuuid
45 changes: 22 additions & 23 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
celery
cryptography
django
djangorestframework
djangorestframework-csv
djangorestframework-queryfields
djangorestframework-simplejwt
django-admin-rangefilter
django-admin-interface
django-debug-toolbar
django-extensions
django-filter
django-import-export
django-json-widget
django-object-actions
django-storages
drf-nested-routers
drf-spectacular
fontawesomefree
celery==5.4.0
cryptography==42.0.8
Django==5.0.6
djangorestframework==3.15.1
djangorestframework-csv==3.0.2
djangorestframework-queryfields==1.1.0
djangorestframework-simplejwt==5.3.1
django-admin-rangefilter==0.13.0
django-admin-interface==0.28.6
django-debug-toolbar==4.4.2
django-extensions==3.2.3
django-filter==24.2
django-import-export==4.0.8
django-json-widget==2.0.1
django-object-actions==4.2.0
django-storages==1.14.3
drf-nested-routers==0.94.1
drf-spectacular==0.27.2
fontawesomefree==6.5.1
nodeorc==0.1.7
pytest-django
psycopg2-binary
shortuuid

pytest-django==4.8.0
psycopg2-binary==2.9.9
shortuuid==1.0.13