ntsm 0.1.3__tar.gz

ntsm-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Adrian Coman
+
+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.

ntsm-0.1.3/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: ntsm
+Version: 0.1.3
+Summary: GIS Custom Modules package
+Author-email: Adrian Coman <adrian.coman@nationaltrust.org.uk>
+License: MIT License
+        
+        Copyright (c) 2024-present Adrian Coman
+        
+        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.
+Project-URL: Homepage, https://github.com/adrian-coman/ntsm
+Project-URL: Issues, https://github.com/adrian-coman/ntsm/issues
+Project-URL: Documentation, https://ntsm.readthedocs.io/en/latest/
+Keywords: ntsm,ntm,nts
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: msal>=1.20.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: loguru>=0.7.0
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.0.0; extra == "docs"
+Requires-Dist: nbsphinx>=0.8.0; extra == "docs"
+Requires-Dist: sphinx-github-alerts>=1.0.0; extra == "docs"
+Requires-Dist: ipython>=7.0.0; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Dynamic: license-file
+
+========================
+NTSM - Vault & Utilities
+========================
+
+.. image:: https://img.shields.io/pypi/v/ntsm.svg
+    :target: https://pypi.org/project/ntsm/
+    :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/ntsm.svg
+    :target: https://pypi.org/project/ntsm/
+    :alt: Supported Python Versions
+
+.. image:: https://readthedocs.org/projects/ntsm/badge/?version=latest
+    :target: https://ntsm.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+    :target: https://opensource.org/licenses/MIT
+    :alt: License: MIT
+
+.. image:: https://img.shields.io/badge/status-beta-orange.svg
+    :target: https://pypi.org/project/ntsm/
+    :alt: Project Status: Beta
+
+The **NTSM** package serves as a central hub for GIS teams, providing a consistent and secure method for managing sensitive credentials across various platforms. Its primary objective is to eliminate hardcoded secrets and unify the connectivity patterns for frequently used APIs like ArcGIS Online or MSAL. 
+
+**Disclaimer & Attribution**
+----------------------------
+This project is an evolved library that incorporates various third-party code snippets and open-source logic. While primary development and architecture are steered by the author(s), many components have been refined, optimized, and adjusted using different AI agents to meet specific production requirements. 
+
+.. note::
+   This package is a **"transition and backward compatibility"** version and not yet a stable release; it should be used with appropriate caution.
+
+Key Features
+------------
+* **Vault Security**: AES-256-GCM encryption with PBKDF2-HMAC-SHA512 key derivation.
+* **Standardized Connections**: Unified interface for ArcGIS, MSAL and more.
+* **Productivity Utilities**: Standardized logging, file handling, archiving, and more.
+
+Installation
+------------
+Install the latest version from PyPI:
+
+.. code-block:: bash
+
+   pip install ntsm
+
+Quick Start
+-----------
+
+.. code-block:: python
+
+    from ntsm.conn import vault
+    # Initialize vault via environment variable
+    v = vault(key_env="GIS_KEY")
+
+    from ntsm.lib import setup_logging
+    logger = setup_logging("my_app", "./logs")
+    logger.info("Application started")
+
+Module Examples
+---------------
+
+Secure Vault (aeadencrypt)
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Modern encryption for sensitive data.
+
+.. code-block:: python
+
+    from ntsm.aeadencrypt import VaultCipher
+    v = VaultCipher(key_name="MY_KEY")
+    encrypted = v.encrypt("secret message")
+    decrypted = v.decrypt(encrypted)
+
+    # Legacy AES-128-CBC
+    from ntsm.aeadencrypt import VaultUtils
+    enc = VaultUtils.encrypt_text("hello", "secret")
+
+Connections (conn)
+~~~~~~~~~~~~~~~~~~
+Easy access to common services.
+
+.. code-block:: python
+
+    from ntsm.conn import agol, msal
+
+    # ArcGIS Online
+    gis = agol(url="https://nt.maps.arcgis.com", user="u", password="p")
+
+    # MSAL Email
+    mail = msal(tenant_id="...", client_id="...", client_email="...", client_secret="...")
+
+Library Utilities (lib)
+~~~~~~~~~~~~~~~~~~~~~~~
+A wide range of helper functions and classes.
+
+.. code-block:: python
+
+    from ntsm.lib import Files, Archive, FormatTime
+
+    # File & Folder management
+    Files.copy_dir("src", "dst")
+    Archive.make_zip("data")
+
+    # Time helpers
+    from datetime import datetime
+    t_str = FormatTime.to_str(datetime.now())
+
+Package Structure
+-----------------
+
+* **ntsm.aeadencrypt**: ``VaultCipher`` (AES-256-GCM), ``VaultUtils`` (Legacy support).
+* **ntsm.conn**: ``vault``, ``agol``, ``token``, ``msal``, and more.
+* **ntsm.lib**: ``Email``, ``Files``, ``Archive``, ``setup_logging``, ``timer_wrap``, and more.
+
+Full Documentation
+------------------
+Access documentation locally or online:
+
+.. code-block:: bash
+
+    # Open the interactive documentation viewer
+    ntsmdocs
+
+Online documentation is hosted at `Read the Docs <https://ntsm.readthedocs.io/>`_.
+
+Contact & Support
+-----------------
+* **Author**: Adrian Coman
+* **Email**: adrian.coman@nationaltrust.org.uk
+* **Project Status**: Transition/Beta

ntsm-0.1.3/README.rst

@@ -0,0 +1,131 @@
+========================
+NTSM - Vault & Utilities
+========================
+
+.. image:: https://img.shields.io/pypi/v/ntsm.svg
+    :target: https://pypi.org/project/ntsm/
+    :alt: PyPI Version
+
+.. image:: https://img.shields.io/pypi/pyversions/ntsm.svg
+    :target: https://pypi.org/project/ntsm/
+    :alt: Supported Python Versions
+
+.. image:: https://readthedocs.org/projects/ntsm/badge/?version=latest
+    :target: https://ntsm.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+    :target: https://opensource.org/licenses/MIT
+    :alt: License: MIT
+
+.. image:: https://img.shields.io/badge/status-beta-orange.svg
+    :target: https://pypi.org/project/ntsm/
+    :alt: Project Status: Beta
+
+The **NTSM** package serves as a central hub for GIS teams, providing a consistent and secure method for managing sensitive credentials across various platforms. Its primary objective is to eliminate hardcoded secrets and unify the connectivity patterns for frequently used APIs like ArcGIS Online or MSAL. 
+
+**Disclaimer & Attribution**
+----------------------------
+This project is an evolved library that incorporates various third-party code snippets and open-source logic. While primary development and architecture are steered by the author(s), many components have been refined, optimized, and adjusted using different AI agents to meet specific production requirements. 
+
+.. note::
+   This package is a **"transition and backward compatibility"** version and not yet a stable release; it should be used with appropriate caution.
+
+Key Features
+------------
+* **Vault Security**: AES-256-GCM encryption with PBKDF2-HMAC-SHA512 key derivation.
+* **Standardized Connections**: Unified interface for ArcGIS, MSAL and more.
+* **Productivity Utilities**: Standardized logging, file handling, archiving, and more.
+
+Installation
+------------
+Install the latest version from PyPI:
+
+.. code-block:: bash
+
+   pip install ntsm
+
+Quick Start
+-----------
+
+.. code-block:: python
+
+    from ntsm.conn import vault
+    # Initialize vault via environment variable
+    v = vault(key_env="GIS_KEY")
+
+    from ntsm.lib import setup_logging
+    logger = setup_logging("my_app", "./logs")
+    logger.info("Application started")
+
+Module Examples
+---------------
+
+Secure Vault (aeadencrypt)
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Modern encryption for sensitive data.
+
+.. code-block:: python
+
+    from ntsm.aeadencrypt import VaultCipher
+    v = VaultCipher(key_name="MY_KEY")
+    encrypted = v.encrypt("secret message")
+    decrypted = v.decrypt(encrypted)
+
+    # Legacy AES-128-CBC
+    from ntsm.aeadencrypt import VaultUtils
+    enc = VaultUtils.encrypt_text("hello", "secret")
+
+Connections (conn)
+~~~~~~~~~~~~~~~~~~
+Easy access to common services.
+
+.. code-block:: python
+
+    from ntsm.conn import agol, msal
+
+    # ArcGIS Online
+    gis = agol(url="https://nt.maps.arcgis.com", user="u", password="p")
+
+    # MSAL Email
+    mail = msal(tenant_id="...", client_id="...", client_email="...", client_secret="...")
+
+Library Utilities (lib)
+~~~~~~~~~~~~~~~~~~~~~~~
+A wide range of helper functions and classes.
+
+.. code-block:: python
+
+    from ntsm.lib import Files, Archive, FormatTime
+
+    # File & Folder management
+    Files.copy_dir("src", "dst")
+    Archive.make_zip("data")
+
+    # Time helpers
+    from datetime import datetime
+    t_str = FormatTime.to_str(datetime.now())
+
+Package Structure
+-----------------
+
+* **ntsm.aeadencrypt**: ``VaultCipher`` (AES-256-GCM), ``VaultUtils`` (Legacy support).
+* **ntsm.conn**: ``vault``, ``agol``, ``token``, ``msal``, and more.
+* **ntsm.lib**: ``Email``, ``Files``, ``Archive``, ``setup_logging``, ``timer_wrap``, and more.
+
+Full Documentation
+------------------
+Access documentation locally or online:
+
+.. code-block:: bash
+
+    # Open the interactive documentation viewer
+    ntsmdocs
+
+Online documentation is hosted at `Read the Docs <https://ntsm.readthedocs.io/>`_.
+
+Contact & Support
+-----------------
+* **Author**: Adrian Coman
+* **Email**: adrian.coman@nationaltrust.org.uk
+* **Project Status**: Transition/Beta

ntsm-0.1.3/VERSION

@@ -0,0 +1 @@
+0.1.3

ntsm-0.1.3/pyproject.toml

@@ -0,0 +1,59 @@
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["ntsm*"]
+
+[project]
+name = "ntsm"
+description = "GIS Custom Modules package"
+readme = "README.rst"
+requires-python = ">=3.10"
+keywords = ["ntsm", "ntm", "nts"]
+license = { file = "LICENSE" }
+authors = [
+  { name = "Adrian Coman", email = "adrian.coman@nationaltrust.org.uk" },
+]
+
+classifiers = [
+  'Development Status :: 4 - Beta',
+  'Intended Audience :: Developers',
+  'License :: OSI Approved :: MIT License',
+  'Operating System :: OS Independent',
+  'Programming Language :: Python :: 3.10',
+  'Topic :: Software Development :: Build Tools',
+]
+
+dependencies = [
+  "cryptography>=41.0.0",
+  "msal>=1.20.0",
+  "requests>=2.28.0",
+  "loguru>=0.7.0",
+]
+
+dynamic = ["version"]
+
+[project.optional-dependencies]
+docs = [
+  "sphinx>=5.0.0",
+  "sphinx-rtd-theme>=1.0.0",
+  "sphinx-autodoc-typehints>=1.0.0",
+  "nbsphinx>=0.8.0",
+  "sphinx-github-alerts>=1.0.0",
+  "ipython>=7.0.0",
+]
+dev = ["twine>=4.0.0", "pytest>=7.0.0"]
+
+
+[tool.setuptools.dynamic]
+version = { file = "VERSION" }
+
+[project.urls]
+Homepage = "https://github.com/adrian-coman/ntsm"
+Issues = "https://github.com/adrian-coman/ntsm/issues"
+Documentation = "https://ntsm.readthedocs.io/en/latest/"
+
+[project.scripts]
+ntsmdocs = "ntsm._docs:_read"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

ntsm-0.1.3/setup.cfg

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

ntsm-0.1.3/src/ntsm/__init__.py

@@ -0,0 +1,7 @@
+from ntsm import aeadencrypt, lib, conn
+
+__all__ = [
+    "aeadencrypt",
+    "lib",
+    "conn",
+]

ntsm-0.1.3/src/ntsm/_docs.py

@@ -0,0 +1,10 @@
+import webbrowser
+
+def _read():
+    """Opens the official Read the Docs page."""
+    url = "https://ntsm.readthedocs.io/en/latest/"
+    print(f"Opening documentation: {url}")
+    webbrowser.open(url, new=2)
+
+if __name__ == "__main__":
+    _read()