muspan 0.0.0__tar.gz

muspan-0.0.0/LICENSE

@@ -0,0 +1 @@
+Please see the file "MuSpAn Academic use licence.pdf" for details of the software licence/license (also available at https://docs.muspan.co.uk/MuSpAn_Academic_use_licence.pdf).

muspan-0.0.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: muspan
+Version: 0.0.0
+Summary: A PyPI hosted importer for the Python package MuSpAn.
+Project-URL: Homepage, https://www.muspan.co.uk
+Project-URL: Documentation, https://docs.muspan.co.uk/latest/Documentation.html
+Project-URL: Repository, https://github.com/joshwillmoore1/MuSpAn-PyPI
+Author-email: Joshua Bull <joshua.bull@maths.ox.ac.uk>, Joshua Moore <joshua.moore@maths.ox.ac.uk>
+Maintainer-email: Joshua Bull <joshua.bull@maths.ox.ac.uk>, Joshua Moore <joshua.moore@maths.ox.ac.uk>
+License: Please see the file "MuSpAn Academic use licence.pdf" for details of the software licence/license (also available at https://docs.muspan.co.uk/MuSpAn_Academic_use_licence.pdf).
+License-File: LICENSE
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# MuSpAn-PyPI
+
+This package is a PyPI hosted installer for the Python Package MuSpAn (www.muspan.co.uk).
+
+Note that MuSpAn is not currently publicly available, and therefore cannot be installed directly through pip without credentials. It is available under an [Academic Use Licence](https://docs.muspan.co.uk/MuSpAn_Academic_use_licence.pdf) and academic/non-commercial verification is required to access the package. For more information, see https://docs.muspan.co.uk/latest/Installation.html#installing-muspan.
+
+If you have attempted to install MuSpAn using this PyPI installer, it will attempt to ask for credentials to install MuSpAn from the official website. We recommend installing directly from [the MuSpAn website](https://docs.muspan.co.uk/latest/Installation) where possible, rather than using this installer.

muspan-0.0.0/README.md

@@ -0,0 +1,7 @@
+# MuSpAn-PyPI
+
+This package is a PyPI hosted installer for the Python Package MuSpAn (www.muspan.co.uk).
+
+Note that MuSpAn is not currently publicly available, and therefore cannot be installed directly through pip without credentials. It is available under an [Academic Use Licence](https://docs.muspan.co.uk/MuSpAn_Academic_use_licence.pdf) and academic/non-commercial verification is required to access the package. For more information, see https://docs.muspan.co.uk/latest/Installation.html#installing-muspan.
+
+If you have attempted to install MuSpAn using this PyPI installer, it will attempt to ask for credentials to install MuSpAn from the official website. We recommend installing directly from [the MuSpAn website](https://docs.muspan.co.uk/latest/Installation) where possible, rather than using this installer.

muspan-0.0.0/muspan/__init__.py

@@ -0,0 +1,72 @@
+import subprocess
+import sys
+from importlib.metadata import version
+
+# the version of this installer package should always be less than 1.0.0
+__version__ = version("muspan")
+
+
+print("")
+print("--------------- MuSpAn Information ---------------")
+print("MuSpAn PyPI installation detected, this installation does not contain MuSpAn.")
+print("MuSpAn package will now be installed from https://www.muspan.co.uk/")
+print(" ")
+print("If you need a username and password, complete the verification form: https://www.muspan.co.uk/get-the-code")
+print("More information: https://docs.muspan.co.uk/latest/Installation.html")
+print(" ")
+print("Attempting installation...")
+print(" ")
+
+
+def install_hosted_package():    
+    try:
+        from IPython import get_ipython
+        shell = get_ipython().__class__.__name__
+        if shell == 'ZMQInteractiveShell':
+            print("--------------- MuSpAn Information ---------------\nPackage called from a ZMQInteractiveShell enviroment (notebook).\n \nIn a new notebook cell, please run:\n\nmuspan.install_package_notebook(username,password)\n \nto install MuSpAn using your username and password access credentials provided by the MuSpAn team.")
+        else:
+            subprocess.check_call([
+            sys.executable, "-m", "pip", "install", "-U",
+            "https://docs.muspan.co.uk/code/latest.zip",
+            ])
+    except NameError:
+        subprocess.check_call([
+            sys.executable, "-m", "pip", "install", "-U",
+            "https://docs.muspan.co.uk/code/latest.zip",
+        ])
+
+# this attempts to run the installer from
+install_hosted_package()
+
+def install_package_notebook(username=None,password=None):
+    """
+    
+    Installs the latest version of the MuSpAn package using PIP from the host repository using the provided username and password following user verification.
+    
+    Parameters
+    ----------
+    username : str
+        Username provided by MuSpAn team for package access.
+    password : str
+        Password provided by MuSpAn team for package access.
+    
+    """
+    # check username and password are strings
+    
+    if not isinstance(username,str):
+        raise ValueError(f'Username for MuSpAn install must be a string')
+    
+    if not isinstance(password,str):
+        raise ValueError(f'Password for MuSpAn install must be a string')
+    
+    try:
+        subprocess.check_call([
+            sys.executable, "-m", "pip", "install", "-U",
+            "https://"+username+":"+password+"@docs.muspan.co.uk/code/latest.zip",
+    
+    ])
+        
+        print('\n--------------- MuSpAn Information ---------------\nPlease restart the kernel to use MuSpAn following notebook installation')    
+        
+    except NameError:
+        print('The installation of MuSpAn using pip has failed.\nPlease see https://docs.muspan.co.uk/latest/Installation.html for installation information.')

muspan-0.0.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "muspan"
+version = "0.0.0"
+description = "A PyPI hosted importer for the Python package MuSpAn."
+readme = "README.md"
+requires-python = ">=3.10"
+
+authors = [
+    { name = "Joshua Bull", email = "joshua.bull@maths.ox.ac.uk" },
+    { name = "Joshua Moore", email = "joshua.moore@maths.ox.ac.uk" }
+]
+
+maintainers = [
+    { name = "Joshua Bull", email = "joshua.bull@maths.ox.ac.uk" },
+    { name = "Joshua Moore", email = "joshua.moore@maths.ox.ac.uk" }
+]
+
+license = { file = "LICENSE" }
+
+[project.urls]
+Homepage = "https://www.muspan.co.uk"
+Documentation = "https://docs.muspan.co.uk/latest/Documentation.html"
+Repository = "https://github.com/joshwillmoore1/MuSpAn-PyPI"