Merge pull request #47 from LukasBommes/update_recent_changes

update recent changes in readme

LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010-2022 Lukas Bommes
+Copyright (c) 2010-2024 Lukas Bommes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -26,18 +26,15 @@ A usage example can be found in `extract_mvs.py`.
 
 ## News
 
-### Recent Changes
+### Recent Changes in Release 1.1.0
 
-- Provided PyPI package
-- Added unittests in tests/tests.py
-- Updated for compatibility with Python >3.8
-- Provided a script to wrap Docker run command
-- Updated demo script with command line arguments for extraction and storing of motion vectors
-- Changed Docker image to manylinux_2_24_x86_64 to prepare for building wheels
-
-### Looking for Contributors
-
-The mv-extractor seems to be quite popular and I want to improve it. However, I do not have the time and resources to do this alone. Hence, I gladly welcome any community contributions.
+- Included community contributions (many thanks to @luowyan and @xyperias)
+- Added support for Python 3.11 and 3.12 and dropped support for Python 3.8
+- Upgraded Docker image from deprecated manylinux_2_24_x86_64 to manylinux_2_28_x86_64
+- Improved CI pipeline to run unit tests on every push to a feature branch
+- Improved the test suite
+- Upgraded build dependencies (OpenCV 4.5.5 -> 4.10.0, numpy 1.x -> 2.0.0)
+- Support numpy 2.x as runtime dependency (see this [issue](https://github.com/LukasBommes/mv-extractor/issues/57))
 
 
 ## Quickstart
@@ -49,7 +46,7 @@ You can install the motion vector extractor via pip
 pip install --upgrade pip
 pip install motion-vector-extractor
 ```
-Note, that we currently provide the package only for x86-64 linux, such as Ubuntu or Debian, and Python 3.8, 3.9, and 3.10. If you are on a different platform, please use the Docker image as described [below](#installation-via-docker).
+Note, that we currently provide the package only for x86-64 linux, such as Ubuntu or Debian, and Python 3.9, 3.10, 3.11, 3.12, and 3.13. If you are on a different platform, please use the Docker image as described [below](#installation-via-docker).
 
 ### Step 2: Extract Motion Vectors
 

release.md

@@ -38,13 +38,17 @@ python3 -m twine upload dist/*
 
 When pushing changes, a Docker image `lubo1994/mv-extractor:dev` is being build and pushed to DockerHub. Upon a release, this image should be tagged with the correct release version and the `latest` tag. To this end, first pull the `dev` image
 ```
-sudo docker pull lubo1994/mv-extractor:dev
+docker pull lubo1994/mv-extractor:dev
 ```
-and then tag and push it as follows
+and then login to the docker registry
 ```
-sudo docker tag lubo1994/mv-extractor:dev lubo1994/mv-extractor:vx.x.x
-sudo docker push lubo1994/mv-extractor:vx.x.x
-sudo docker tag lubo1994/mv-extractor:vx.x.x lubo1994/mv-extractor:latest
-sudo docker push lubo1994/mv-extractor:latest
+cat docker_registry_password.txt | docker login --username <username> --password-stdin
+```
+and tag and push the image as follows
+```
+docker tag lubo1994/mv-extractor:dev lubo1994/mv-extractor:vx.x.x
+docker push lubo1994/mv-extractor:vx.x.x
+docker tag lubo1994/mv-extractor:vx.x.x lubo1994/mv-extractor:latest
+docker push lubo1994/mv-extractor:latest
 ```
 where `vx.x.x` is replaced with the version of the release.