automatic-time-lapse-creator 0.0.0__tar.gz

automatic_time_lapse_creator-0.0.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.

automatic_time_lapse_creator-0.0.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.1
+Name: automatic_time_lapse_creator
+Version: 0.0.0
+Summary: automatic_time_lapse_creator is a Python program for scraping images from a web cam url and converting them into a timelapse
+Author-email: Kaloyan Peychev <kokoeverest@gmail.com>
+Maintainer-email: Kaloyan Peychev <kokoeverest@gmail.com>
+Project-URL: Repository, https://github.com/kokoeverest/Automatic-time-lapse-creator
+Project-URL: Issues, https://github.com/kokoeverest/Automatic-time-lapse-creator/issues
+Keywords: requests,astral,opencv,opencv-python,timelapse,video,mp4,webcam
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astral>=3.2
+Requires-Dist: certifi>=2024.8.30
+Requires-Dist: charset-normalizer>=3.4.0
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: idna>=3.10
+Requires-Dist: iniconfig>=2.0.0
+Requires-Dist: numpy>=2.1.3
+Requires-Dist: opencv-python>=4.10.0.84
+Requires-Dist: packaging>=24.2
+Requires-Dist: pluggy>=1.5.0
+Requires-Dist: pytest>=8.3.3
+Requires-Dist: requests>=2.32.3
+Requires-Dist: tzdata>=2024.2
+Requires-Dist: urllib3>=2.2.3
+
+# Automatic time lapse creator
+
+### A Python package for extracting images from a web cam url and converting these images into a timelapse. The process is intended to be automatic, so the only parameters that need to be provided are:
+
++ the image resourse url/urls pointing to an image *(not video!)*
++ the path on your computer where the images will be stored *(default is os.getcwd())*
++ the location of the city (or coordinates) for which the daylight will be calculated *(default is Sofia, Bulgaria)*
+
+### The purpose of the program is to get an archive/history of the weather in any place that has accessible web cam, so people can actually see what the real weather was like in this place and compare it with weather forecast and/or data from a weather station.
+
+### Libraries used in the program:
++ Astral (https://astral.readthedocs.io/en/latest/) - to get the 
+sunrise and sunset time of the day for a specific geolocation
++ OpenCV-Python (https://pypi.org/project/opencv-python/) - to 
+read/resize the jpeg files and build a time lapse mp4 video
++ Requests - builtin module used to retrieve the image from the url
++ Logging - the builtin python looging tool for creating comprehensive 
+logs of the program execution
+
+### Main flow and automation of the app:
+#### When the execution of the TimeLapseCreator object starts, it will check if it's daylight at the provided location. Daylight is calculated automatically using the Astral library so there will be few or no images collected during the night. After the collection of images finishes for the day the VideoManager creates a video from the collected images for each of the provided sources and deletes all the images for the day. In case of an interruption of the collection of images during the day (for example: power outage -> the program stops and then it's started again), the video will still be created but the daily images won't be deleted. In this case you can inspect them and create a video manually from the pictures that are worth it.
+#### During the night the program will not collect any images - they will be collected when there is daylight - the smart power of the Astral library ;)
+
+#### A valid scenario for creating a TimeLapseCreator for webcams in Bulgaria:
+*Note that no location is provided in this example, so the TimeLapseCreator will be instantiated for the default location: Sofia, Bulgaria.*
+```python
+from automatic_time_lapse_creator.time_lapse_creator import TimeLapseCreator
+from automatic_time_lapse_creator.source import Source
+
+# Valid sources
+borovets_source = Source(
+    "markudjik", "https://media.borovets-bg.com/cams/channel?channel=31"
+)
+pleven_hut_source = Source(
+    "plevenhut", "https://meter.ac/gs/nodes/N160/snap.jpg?1705436803718"
+)
+
+sources_list: list[Source] = [borovets_source, pleven_hut_source]
+
+# creating a TimeLapseCreator can be done in two ways:
+# instantiate the creator directly with the list of Sources
+bulgaria_webcams = TimeLapseCreator(sources_list)
+
+# or create a new TimeLapseCreator and add the list of Sources
+# with the add_sources method
+bulgaria_webcams = TimeLapseCreator()
+bulgaria_webcams.add_sources(sources_list)
+
+# if you try to instantiate a new TimeLapseCreator with a single Source, it will raise an InvalidCollectionException
+# for example:
+pleven_hut_webcam = TimeLapseCreator(pleven_hut_source)
+# output:
+Traceback...:
+...in validate_collection
+    raise InvalidCollectionException(
+src.automatic_time_lapse_creator.common.exceptions.InvalidCollectionException: Only list, tuple or set collections are allowed!
+
+# start the collection of the images with the execute() method
+bulgaria_webcams.execute()
+```
+
+An invalid scenario will be:
+```python
+# Invalid source
+sample_source_with_empty_url = Source("fake", "https://empty.url")
+
+invalid_source_list = [sample_source_with_empty_url]
+
+invalid_url_creator = TimeLapseCreator(invalid_source_list)
+
+invalid_url_creator.execute()
+```
+
+Should you have any questions, bug reports or recommendations, feel free to send an email to *kokoeverest[@]gmail.com*

automatic_time_lapse_creator-0.0.0/README.md

@@ -0,0 +1,74 @@
+# Automatic time lapse creator
+
+### A Python package for extracting images from a web cam url and converting these images into a timelapse. The process is intended to be automatic, so the only parameters that need to be provided are:
+
++ the image resourse url/urls pointing to an image *(not video!)*
++ the path on your computer where the images will be stored *(default is os.getcwd())*
++ the location of the city (or coordinates) for which the daylight will be calculated *(default is Sofia, Bulgaria)*
+
+### The purpose of the program is to get an archive/history of the weather in any place that has accessible web cam, so people can actually see what the real weather was like in this place and compare it with weather forecast and/or data from a weather station.
+
+### Libraries used in the program:
++ Astral (https://astral.readthedocs.io/en/latest/) - to get the 
+sunrise and sunset time of the day for a specific geolocation
++ OpenCV-Python (https://pypi.org/project/opencv-python/) - to 
+read/resize the jpeg files and build a time lapse mp4 video
++ Requests - builtin module used to retrieve the image from the url
++ Logging - the builtin python looging tool for creating comprehensive 
+logs of the program execution
+
+### Main flow and automation of the app:
+#### When the execution of the TimeLapseCreator object starts, it will check if it's daylight at the provided location. Daylight is calculated automatically using the Astral library so there will be few or no images collected during the night. After the collection of images finishes for the day the VideoManager creates a video from the collected images for each of the provided sources and deletes all the images for the day. In case of an interruption of the collection of images during the day (for example: power outage -> the program stops and then it's started again), the video will still be created but the daily images won't be deleted. In this case you can inspect them and create a video manually from the pictures that are worth it.
+#### During the night the program will not collect any images - they will be collected when there is daylight - the smart power of the Astral library ;)
+
+#### A valid scenario for creating a TimeLapseCreator for webcams in Bulgaria:
+*Note that no location is provided in this example, so the TimeLapseCreator will be instantiated for the default location: Sofia, Bulgaria.*
+```python
+from automatic_time_lapse_creator.time_lapse_creator import TimeLapseCreator
+from automatic_time_lapse_creator.source import Source
+
+# Valid sources
+borovets_source = Source(
+    "markudjik", "https://media.borovets-bg.com/cams/channel?channel=31"
+)
+pleven_hut_source = Source(
+    "plevenhut", "https://meter.ac/gs/nodes/N160/snap.jpg?1705436803718"
+)
+
+sources_list: list[Source] = [borovets_source, pleven_hut_source]
+
+# creating a TimeLapseCreator can be done in two ways:
+# instantiate the creator directly with the list of Sources
+bulgaria_webcams = TimeLapseCreator(sources_list)
+
+# or create a new TimeLapseCreator and add the list of Sources
+# with the add_sources method
+bulgaria_webcams = TimeLapseCreator()
+bulgaria_webcams.add_sources(sources_list)
+
+# if you try to instantiate a new TimeLapseCreator with a single Source, it will raise an InvalidCollectionException
+# for example:
+pleven_hut_webcam = TimeLapseCreator(pleven_hut_source)
+# output:
+Traceback...:
+...in validate_collection
+    raise InvalidCollectionException(
+src.automatic_time_lapse_creator.common.exceptions.InvalidCollectionException: Only list, tuple or set collections are allowed!
+
+# start the collection of the images with the execute() method
+bulgaria_webcams.execute()
+```
+
+An invalid scenario will be:
+```python
+# Invalid source
+sample_source_with_empty_url = Source("fake", "https://empty.url")
+
+invalid_source_list = [sample_source_with_empty_url]
+
+invalid_url_creator = TimeLapseCreator(invalid_source_list)
+
+invalid_url_creator.execute()
+```
+
+Should you have any questions, bug reports or recommendations, feel free to send an email to *kokoeverest[@]gmail.com*

automatic_time_lapse_creator-0.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "automatic_time_lapse_creator"
+authors = [
+  { name="Kaloyan Peychev", email="kokoeverest@gmail.com" },
+]
+maintainers = [
+  { name="Kaloyan Peychev", email="kokoeverest@gmail.com" },
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "astral>=3.2",
+    "certifi>=2024.8.30",
+    "charset-normalizer>=3.4.0",
+    "colorama>=0.4.6",
+    "idna>=3.10",
+    "iniconfig>=2.0.0",
+    "numpy>=2.1.3",
+    "opencv-python>=4.10.0.84",
+    "packaging>=24.2",
+    "pluggy>=1.5.0",
+    "pytest>=8.3.3",
+    "requests>=2.32.3",
+    "tzdata>=2024.2",
+    "urllib3>=2.2.3",
+]
+description = "automatic_time_lapse_creator is a Python program for scraping images from a web cam url and converting them into a timelapse" 
+dynamic = ["version"]
+keywords = ["requests", "astral", "opencv", "opencv-python", "timelapse", "video", "mp4", "webcam"]
+readme = "README.md"
+requires-python = ">=3.10"
+
+[project.urls]
+Repository = "https://github.com/kokoeverest/Automatic-time-lapse-creator"
+Issues = "https://github.com/kokoeverest/Automatic-time-lapse-creator/issues"

automatic_time_lapse_creator-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

automatic_time_lapse_creator-0.0.0/src/automatic_time_lapse_creator/cache_manager.py

@@ -0,0 +1,19 @@
+import pickle
+
+
+class CacheManager:
+    """Class for managing the state of TimeLapseCreator objects. State of the object
+    is saved (pickled) in a file and the filename has a prefix *cache_* and ends with 
+    the *location_name* attribute of the TimeLapseCreator"""
+
+    @classmethod
+    def write(cls, time_lapse_creator: object, location: str):
+        """Writes the TimeLapseCreator object to a file, overwriting existing objects
+        if the file already exists"""
+        pickle.dump(time_lapse_creator, open(f"cache_{location}.p", "wb"))
+
+    @classmethod
+    def get(cls, location: str):
+        """Retrieves the pickled object in the file. If the file is empty or if it is not found
+        it will return an Exception"""
+        return pickle.load(open(f"cache_{location}.p", "rb"))

automatic_time_lapse_creator-0.0.0/src/automatic_time_lapse_creator/common/constants.py

@@ -0,0 +1,15 @@
+JPG_FILE = ".jpg"
+MP4_FILE = ".mp4"
+LOG_FILE = ".log"
+YYMMDD_FORMAT = "%Y-%m-%d"
+HHMMSS_UNDERSCORE_FORMAT = "%H_%M_%S"
+HHMMSS_COLON_FORMAT = "%H:%M:%S %p"
+OK_STATUS_CODE = 200
+NO_CONTENT_STATUS_CODE = 204
+LOGGING_FORMAT = "%(name)s: %(asctime)s - %(levelname)s - %(message)s"
+DEFAULT_CITY_NAME = "Sofia"
+DEFAULT_SECONDS_BETWEEN_FRAMES = 60
+DEFAULT_NIGHTTIME_RETRY_SECONDS = 300
+DEFAULT_VIDEO_FPS = 30
+DEFAULT_VIDEO_WIDTH = 640
+DEFAULT_VIDEO_HEIGHT = 360

automatic_time_lapse_creator-0.0.0/src/automatic_time_lapse_creator/common/exceptions.py

@@ -0,0 +1,13 @@
+class UnknownLocationException(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)
+
+
+class InvalidStatusCodeException(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)
+
+
+class InvalidCollectionException(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)

automatic_time_lapse_creator-0.0.0/src/automatic_time_lapse_creator/common/utils.py

@@ -0,0 +1,13 @@
+def create_log_message(location: str, url: str, method: str):
+    """
+    Creates an appropriate log message according to the method which calls it
+
+    Returns::
+
+        str - the log message if the method is 'add' or 'remove'"""
+    if method == "add":
+        return f"Source with location: {location} or url: {url} already exists!"
+    elif method == "remove":
+        return f"Source with location: {location} or url: {url} doesn't exist!"
+    else:
+        return f"Unknown command: {method}"

automatic_time_lapse_creator-0.0.0/src/automatic_time_lapse_creator/source.py

@@ -0,0 +1,69 @@
+class Source:
+    """Contains two public attributes and four read-only attributes, which can be changed
+    through the respective methods.
+
+    Attributes::
+
+        location_name: str - a folder with that name will be created on your pc. The videos
+            for every day of the execution of the TimeLapseCreator will be created and put into
+            subfolders into the "location_name" folder
+
+        url: str - a valid web address where a webcam frame (image) should be located.
+        
+    ##### Be sure that the url does not point to a video resource."""
+
+    def __init__(self, location_name: str, url: str) -> None:
+        self.location_name: str = location_name
+        self.url: str = url
+        self._video_created: bool = False
+        self._images_count: int = 0
+        self._all_images_collected: bool = False
+        self._images_partially_collected: bool = False
+
+    @property
+    def images_collected(self):
+        return self._all_images_collected
+
+    @property
+    def images_partially_collected(self):
+        return self._images_partially_collected
+
+    @property
+    def images_count(self):
+        return self._images_count
+
+    @property
+    def video_created(self):
+        return self._video_created
+
+    def set_video_created(self):
+        """Set the video_created to True"""
+        self._video_created = True
+
+    def reset_video_created(self):
+        """Reset the video_created to False"""
+        self._video_created = False
+
+    def increase_images(self):
+        """Increases the count of the images by 1"""
+        self._images_count += 1
+
+    def reset_images_counter(self):
+        """Resets the images count to 0"""
+        self._images_count = 0
+
+    def set_all_images_collected(self):
+        """Sets the self._all_images_collected to True"""
+        self._all_images_collected = True
+
+    def set_images_partially_collected(self):
+        """Sets the self._images_partially_collected to True"""
+        self._images_partially_collected = True
+
+    def reset_all_images_collected(self):
+        """Resets the self._all_images_collected to False"""
+        self._all_images_collected = False
+
+    def reset_images_pertially_collected(self):
+        """Resets the self._images_partially_collected to False"""
+        self._images_partially_collected = False