aptracker 1.0.0__tar.gz

aptracker-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Debmalya Pramanik
+
+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.

aptracker-1.0.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: aptracker
+Version: 1.0.0
+Summary: Advanced Project Tracker and Manager Application
+Home-page: https://github.com/PyUtility/aptracker
+License: MIT License
+        
+        Copyright (c) 2016 Debmalya Pramanik
+        
+        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.
+        
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+<div align = "center">
+
+# Advanced Python (AP) Project Tracker
+
+</div>
+
+<div align = "justify">
+
+**`APTracker`** is an advanced Python module for tracking multiple projects running on a single/distributed cluster using
+managers and/or objects to handle/track different projects.
+
+## Getting Started
+
+The project is available in [PyPI](https://pypi.org/p/aptracker) and can be installed using standard `pip` library or other
+default package managers as below:
+
+```shell
+pip install aptracker
+```
+
+## Contribution Guidelines
+
+All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed
+overview on how to contribute can be found in the **contributing guidelines**. If you run into an issue, please file a new
+[issue](https://github.com/PyUtility/apttracker/issues) for discussion. Create a pull request for a new feature or a fix to
+an existing issue [here](https://github.com/PyUtility/aptracker/pulls).
+
+As contributors and maintainers to this project, you are expected to abide by [PyUtility](https://github.com/PyUtility)'s
+code of conduct. More information can be found at: **Contributor Code of Conduct**.
+
+</div>

aptracker-1.0.0/README.md

@@ -0,0 +1,31 @@
+<div align = "center">
+
+# Advanced Python (AP) Project Tracker
+
+</div>
+
+<div align = "justify">
+
+**`APTracker`** is an advanced Python module for tracking multiple projects running on a single/distributed cluster using
+managers and/or objects to handle/track different projects.
+
+## Getting Started
+
+The project is available in [PyPI](https://pypi.org/p/aptracker) and can be installed using standard `pip` library or other
+default package managers as below:
+
+```shell
+pip install aptracker
+```
+
+## Contribution Guidelines
+
+All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed
+overview on how to contribute can be found in the **contributing guidelines**. If you run into an issue, please file a new
+[issue](https://github.com/PyUtility/apttracker/issues) for discussion. Create a pull request for a new feature or a fix to
+an existing issue [here](https://github.com/PyUtility/aptracker/pulls).
+
+As contributors and maintainers to this project, you are expected to abide by [PyUtility](https://github.com/PyUtility)'s
+code of conduct. More information can be found at: **Contributor Code of Conduct**.
+
+</div>

aptracker-1.0.0/aptracker/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+"""
+APTracker - Advanced Python (AP) Project Tracker & Manager
+==========================================================
+
+Working on multiple projects, or want to track different projects
+running in a production environment efficiently using ``aptracker``
+that provides simple context managers, classes etc. with a dynamic
+dashboard of the performance logs.
+"""
+
+__version__ = "v1.0.0"
+
+# ? added init time options registrations from aptracker.api
+from aptracker.api import * # noqa: F401, F403 # pyright: ignore[reportMissingImports]

aptracker-1.0.0/aptracker/api.py

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+
+"""
+Initialization time option registrations and expose callables at
+module level for :mod:`aptracker` module.
+"""
+
+from aptracker.session import SessionConfig
+
+__all__ = [
+    "SessionConfig"
+]

aptracker-1.0.0/aptracker/session.py

@@ -0,0 +1,110 @@
+# -*- encoding: utf-8 -*-
+
+"""
+Track a project that has multiple instances or sessions running in a
+production environment using session managers that can be used to set
+an unique identity and can be tracked from a centralized system.
+"""
+
+import os
+import getpass
+import subprocess
+import datetime as dt
+
+from uuid import uuid4 as UUIDx
+from dataclasses import dataclass
+
+@dataclass(frozen = True)
+class SessionConfig:
+    """
+    A Strictly Frozen Data Class for to Handle Sessions of a Project
+
+    A session of a project can be running instances or schedules on a
+    production environment. The session can be tracked using a unique
+    key and can be referenced back to the project.
+
+    :type  JOB_NAME: str
+    :param JOB_NAME: Name of the job, this can be a "human-redable"
+        name or a unique project ket that can be used identify the
+        project. An efficient system should be able to track the job
+        and all its associated sessions using this key.
+
+    :type  SESSION_ID: str
+    :param SESSION_ID: A unique session identity key, defaults to
+        ``UUID`` that can be used for a particular project.
+
+    :type  SCHEDULED_ON: dt.datetime
+    :param SCHEDULED_ON: The date and time when the session was
+        created, defaults to ``dt.datetime.now()`` value.
+
+    :type  SCHEDULED_BY: str
+    :param SCHEDULED_BY: Name of the user, machine or instance where
+        the session was created.
+
+    :type  ENVIRONMENT: str
+    :param ENVIRONMENT: Environment details, defaults to ``dev``. Any
+        values can be set and there is no restriction.
+
+    :type  VERBOSEMODE: bool
+    :param VERBOSEMODE: Verbose details into console when True
+        (default) during post initialization.
+
+    The data class is defined as ``frozen`` as once initialized this
+    value should not be changed or altered. Example usage:
+
+    .. code-block:: python
+
+        import aptracker as apt
+
+        session = apt.SessionConfig(JOB_NAME = "Example Job")
+        >> Session ID : ABC... Crated for 'Example Job' at ...
+    """
+
+    JOB_NAME : str
+
+    # ? global frozen values for a project run, with default values
+    SESSION_ID : str = str(UUIDx()).upper()
+    SCHEDULED_ON : dt.datetime = dt.datetime.now()
+    SCHEDULED_BY : str = getpass.getuser()
+
+    # ? control for environment, verbose statements
+    ENVIRONMENT : str = "dev"
+    VERBOSEMODE : bool = True
+
+
+    @property
+    def PROJECT_ROOT(self) -> str:
+        """
+        Define Root Directory for the Project if Version Controlled
+
+        The root of the project can be defined directly, if version
+        controlled using ``git``, else sets to the current directory.
+        The value is always absolute path to the project.
+        """
+
+        root = os.path.join(subprocess.Popen(
+            ['git', 'rev-parse', '--show-toplevel'],
+            stdout=subprocess.PIPE
+        ).communicate()[0].rstrip().decode('utf-8'))
+
+        return root or os.path.abspath(os.path.dirname(__file__))
+
+
+    def __post_init__(self) -> None:
+        """
+        Post Session Initialization Verbose Details into Console/Log
+
+        When a session is created, log details into console about the
+        session and other important attributes. Useful in development
+        environment, can be toggled based on object.
+        """
+
+        statement = f"Session ID : {self.SESSION_ID} " \
+            + f"Created for '{self.JOB_NAME}' at {self.SCHEDULED_ON}"
+        
+        if self.VERBOSEMODE:
+            print(statement)
+        else:
+            pass
+
+        return

aptracker-1.0.0/aptracker.egg-info/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: aptracker
+Version: 1.0.0
+Summary: Advanced Project Tracker and Manager Application
+Home-page: https://github.com/PyUtility/aptracker
+License: MIT License
+        
+        Copyright (c) 2016 Debmalya Pramanik
+        
+        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.
+        
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+<div align = "center">
+
+# Advanced Python (AP) Project Tracker
+
+</div>
+
+<div align = "justify">
+
+**`APTracker`** is an advanced Python module for tracking multiple projects running on a single/distributed cluster using
+managers and/or objects to handle/track different projects.
+
+## Getting Started
+
+The project is available in [PyPI](https://pypi.org/p/aptracker) and can be installed using standard `pip` library or other
+default package managers as below:
+
+```shell
+pip install aptracker
+```
+
+## Contribution Guidelines
+
+All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. A detailed
+overview on how to contribute can be found in the **contributing guidelines**. If you run into an issue, please file a new
+[issue](https://github.com/PyUtility/apttracker/issues) for discussion. Create a pull request for a new feature or a fix to
+an existing issue [here](https://github.com/PyUtility/aptracker/pulls).
+
+As contributors and maintainers to this project, you are expected to abide by [PyUtility](https://github.com/PyUtility)'s
+code of conduct. More information can be found at: **Contributor Code of Conduct**.
+
+</div>

aptracker-1.0.0/aptracker.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+aptracker/__init__.py
+aptracker/api.py
+aptracker/session.py
+aptracker.egg-info/PKG-INFO
+aptracker.egg-info/SOURCES.txt
+aptracker.egg-info/dependency_links.txt
+aptracker.egg-info/top_level.txt

aptracker-1.0.0/aptracker.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

aptracker-1.0.0/aptracker.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+aptracker
+dist
+docs

aptracker-1.0.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = [
+    "setuptools==82.0.1",
+    "wheel==0.46.3"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aptracker"
+dynamic = ["version"]
+description = "Advanced Project Tracker and Manager Application"
+readme = {file = "README.md", content-type = "text/markdown"}
+requires-python = ">=3.12"
+license = {file = "LICENSE" }
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: Unix",
+    "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License"
+]
+
+[tool.setuptools]
+py-modules = []
+
+[tool.setuptools.packages.find]
+exclude = ["tests*", "examples*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "aptracker.__version__"}

aptracker-1.0.0/setup.cfg

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

aptracker-1.0.0/setup.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+
+import os
+import sys
+
+from setuptools import setup
+from setuptools import find_packages
+
+sys.path.append(
+    os.path.join(os.path.dirname(__file__))
+)
+
+import aptracker
+
+setup(
+    name = "aptracker",
+    version = aptracker.__version__,
+    description = "Advanced Project Tracker and Manager Application",
+    long_description = open("README.md", "r").read(),
+    long_description_content_type = "text/markdown",
+    url = "https://github.com/PyUtility/aptracker",
+    packages = find_packages(
+        exclude = ["tests*", "examples*"]
+    ),
+    classifiers = [
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "Intended Audience :: Education",
+        "Intended Audience :: End Users/Desktop",
+        "Operating System :: Unix",
+        "Operating System :: POSIX",
+        "Operating System :: Microsoft :: Windows",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3.12",
+        "License :: OSI Approved :: MIT License"
+    ],
+    python_requires = ">=3.12"
+)