psu-python 0.1.0__tar.gz → 0.2.3__tar.gz

psu_python-0.2.3/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: psu-python
+Version: 0.2.3
+Summary: A python package for abstracting python class methods behind a fully functional layer intended for educational use in CMPSC 131 at The Pennsylvania State University
+Author-email: Theodore Tasman <psupython@ttasman.com>
+License-Expression: GPL-3.0
+Project-URL: Homepage, https://tedtasman.github.io/psu-python/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0.0; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Dynamic: license-file
+
+# PSU Python
+
+A python package for abstracting python class methods behind a fully functional layer. Intended for educational use in CMPSC 131 at The Pennsylvania State University. [Packaged for distribution on PyPi](https://pypi.org/project/psu-python/)
+
+## Usage
+
+psu-python is packaged and available on PyPi. To use psu-python, install it with pip in your python environment:
+
+```bash
+pip install psu-python
+```
+
+You will now be able to import psu-python modules in your python code:
+
+```python
+# import all functions
+from psu_python import *
+# or specific ones
+from psu_python import to_lower, get_item
+
+def main():
+    ...
+```
+
+## Developer Install
+
+1. Clone the repository
+
+   ```bash
+   git clone git@github.com:tedtasman/psu-python.git
+   cd ./psu-python
+   ```
+
+2. Create a virtual environment
+   - MacOS / Linux:
+     ```bash
+     python3 -m venv .venv
+     source ./.venv/bin/activate
+     ```
+   - Windows Powershell
+     ```Powershell
+     python -m venv .venv
+     .\.venv\Scripts\activate
+     ```
+
+3. Install psu-python locally in editable mode
+   ```bash
+   pip install -e .
+   ```

psu_python-0.2.3/README.md

@@ -0,0 +1,49 @@
+# PSU Python
+
+A python package for abstracting python class methods behind a fully functional layer. Intended for educational use in CMPSC 131 at The Pennsylvania State University. [Packaged for distribution on PyPi](https://pypi.org/project/psu-python/)
+
+## Usage
+
+psu-python is packaged and available on PyPi. To use psu-python, install it with pip in your python environment:
+
+```bash
+pip install psu-python
+```
+
+You will now be able to import psu-python modules in your python code:
+
+```python
+# import all functions
+from psu_python import *
+# or specific ones
+from psu_python import to_lower, get_item
+
+def main():
+    ...
+```
+
+## Developer Install
+
+1. Clone the repository
+
+   ```bash
+   git clone git@github.com:tedtasman/psu-python.git
+   cd ./psu-python
+   ```
+
+2. Create a virtual environment
+   - MacOS / Linux:
+     ```bash
+     python3 -m venv .venv
+     source ./.venv/bin/activate
+     ```
+   - Windows Powershell
+     ```Powershell
+     python -m venv .venv
+     .\.venv\Scripts\activate
+     ```
+
+3. Install psu-python locally in editable mode
+   ```bash
+   pip install -e .
+   ```

psu_python-0.2.3/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name='psu-python'
+version='0.2.3'
+description='A python package for abstracting python class methods behind a fully functional layer intended for educational use in CMPSC 131 at The Pennsylvania State University'
+authors=[
+    {name='Theodore Tasman', email='psupython@ttasman.com'}
+]
+license='GPL-3.0'
+readme='README.md'
+dependencies=[]
+classifiers=[
+    'Development Status :: 3 - Alpha',
+    'Intended Audience :: Education',
+    'Programming Language :: Python :: 3',
+    'Operating System :: OS Independent',
+    'Natural Language :: English',
+]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx>=4.0.0",
+    "furo",
+    "sphinx-autodoc-typehints",
+]
+
+[project.urls]
+Homepage = 'https://tedtasman.github.io/psu-python/'
+

psu_python-0.2.3/src/psu_python/__init__.py

@@ -0,0 +1,15 @@
+from psu_python.dictionaries import delete, get_items, get_keys, get_value, get_values
+from psu_python.lists import join, append, pop
+from psu_python.strings import split
+
+__all__ = [
+    "delete",
+    "get_items",
+    "get_keys",
+    "get_value",
+    "get_values",
+    "join",
+    "append",
+    "pop",
+    "split",
+]

psu_python-0.2.3/src/psu_python/dictionaries.py

@@ -0,0 +1,91 @@
+from typing import Any
+from collections.abc import KeysView, ValuesView, ItemsView
+
+# I don't love using `d` for the dictionary parameter but I'm not sure what would be better
+
+# delete key from d
+# this is really just d.pop(key), but I can't call it pop because that collides with the list version
+def delete(key: Any, d: dict) -> Any:
+    """Remove `key` from dictionary `d` and return its value.
+
+    Args:
+        key (Any): The list index for the element to remove.
+        d (dict): The dictionary to remove from.
+
+    Raises:
+        KeyError: `key` must exist within `d`.
+
+    Returns:
+        Any: The value of the popped key.
+    """
+    if not isinstance(d, dict):
+        raise TypeError("d must be of type dict")
+    
+    value = d.pop(key)
+
+    if value is None:
+        raise KeyError(f"Key \"{key}\" not in dictionary")
+    
+    return value
+
+
+def get_keys(d: dict) -> KeysView:
+    """Get a dynamic view object of the dictionary `d`'s keys that reflects changes to `d`.
+
+    Args:
+        d (dict): the dictionary.
+
+    Returns:
+        KeysView: A view of the keys in `d`.
+    """
+    if not isinstance(d, dict):
+        raise TypeError("d must be of type dict")
+    
+    return d.keys()
+
+
+def get_values(d: dict) -> ValuesView:
+    """Get a dynamic view object of the dictionary `d`'s values that reflects changes to `d`.
+
+    Args:
+        d (dict): the dictionary.
+
+    Returns:
+        ValuesView: A view of the values in `d`.
+    """
+    if not isinstance(d, dict):
+        raise TypeError("d must be of type dict")
+    
+    return d.values()
+
+
+def get_items(d: dict) -> ItemsView:
+    """Get a dynamic view object of the dictionary `d`'s key, value pairs that reflects changes to `d`
+
+    Args:
+        d (dict): the dictionary.
+
+    Returns:
+        ValuesView: A view of the (key, value) tuple pairs in `d`.
+    """
+    if not isinstance(d, dict):
+        raise TypeError("d must be of type dict")
+    
+    return d.items()
+
+# get key from d
+def get_value(key: Any, d: dict, default: Any = None) -> Any:
+    """Get the value corresponding to `key` from `d`. If `key` is not in `d`, returns `default`.
+
+    Args:
+        key (Any): the key to get from `d`.
+        d (dict): the dictionary to check for `key`.
+        default (Any, optional): the value to return if `key` is not in `d`. If not specified, defaults to `None`.
+
+    Returns:
+        Any: The value corresponding to `key`, or `default` if not in `d`.
+    """
+    if not isinstance(d, dict):
+        raise TypeError("d must be of type dict")
+    
+    return d.get(key, default)

psu_python-0.2.3/src/psu_python/lists.py

@@ -0,0 +1,58 @@
+from typing import Any, Optional
+
+# "join list by separator"
+def join(lst: list, separator: str) -> str:
+    """Join elements of a list into a single string, separated by a delimiter.
+
+    Args:
+        lst (list): the list to join
+        separator (str): string to separate list elements
+        
+    Returns:
+        str: a joined string of the list elements
+    """
+    if not isinstance(separator, str):
+        raise TypeError("separator must be of type str")
+    if not isinstance(lst, list):
+        raise TypeError("lst must be of type list")
+
+    return separator.join(lst)
+
+# "append element to list"
+def append(element: Any, lst: list) -> None:
+    """Append `element` to the end of `lst`. Modifies `lst`.
+
+    Args:
+        lst (list): the list to append to
+        element (Any): the item to append
+    """
+    if not isinstance(lst, list):
+        raise TypeError("lst must be of type list")
+    lst.append(element)
+
+# "pop list[index]"
+def pop(lst: list, index: Optional[int] = None) -> Any:
+    """Remove and return the element at position `index` from `lst`. 
+
+    Args:
+        lst (list): The list to remove from.
+        index (int, optional): The list index for the element to remove. If not specified or `None`, pops last element.
+
+    Raises:
+        IndexError: `index` must exist within `lst`.
+
+    Returns:
+        Any: The popped element.
+    """
+    if not isinstance(lst, list):
+        raise TypeError("lst must be of type list")
+    if not isinstance(index, int) and index is not None:
+        raise TypeError("index must be None or of type int")
+    
+    if index is not None and (index > len(lst) - 1 or -1 * index > len(lst)):
+        raise IndexError("pop index out of range")
+    
+    if index is None:
+        return lst.pop()
+    
+    return lst.pop(index)

psu_python-0.2.3/src/psu_python/strings.py

@@ -0,0 +1,20 @@
+from typing import Optional
+
+# split string by sep
+def split(string: str, sep: Optional[str] = None, maxsplit: int = -1) -> list[str]:
+    """Create a list of words in `string` separated by `sep`.
+
+    Args:
+        string (str): The string to split.
+        separator (str, optional): The separator delimiting words. If not specified or `None`, splits at whitespace.
+        maxsplit (int, optional): The maximum number of splits to complete. If not specified or `-1`, all possible splits are made.
+
+    Returns:
+        list: A list containing the words after splitting.
+    """
+    if not isinstance(string, str):
+        raise TypeError("string must be of type str")
+    if not isinstance(sep, str) and sep is not None:
+        raise TypeError("separator must be of type str")
+    
+    return string.split(sep, maxsplit)

psu_python-0.2.3/src/psu_python.egg-info/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: psu-python
+Version: 0.2.3
+Summary: A python package for abstracting python class methods behind a fully functional layer intended for educational use in CMPSC 131 at The Pennsylvania State University
+Author-email: Theodore Tasman <psupython@ttasman.com>
+License-Expression: GPL-3.0
+Project-URL: Homepage, https://tedtasman.github.io/psu-python/
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0.0; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Dynamic: license-file
+
+# PSU Python
+
+A python package for abstracting python class methods behind a fully functional layer. Intended for educational use in CMPSC 131 at The Pennsylvania State University. [Packaged for distribution on PyPi](https://pypi.org/project/psu-python/)
+
+## Usage
+
+psu-python is packaged and available on PyPi. To use psu-python, install it with pip in your python environment:
+
+```bash
+pip install psu-python
+```
+
+You will now be able to import psu-python modules in your python code:
+
+```python
+# import all functions
+from psu_python import *
+# or specific ones
+from psu_python import to_lower, get_item
+
+def main():
+    ...
+```
+
+## Developer Install
+
+1. Clone the repository
+
+   ```bash
+   git clone git@github.com:tedtasman/psu-python.git
+   cd ./psu-python
+   ```
+
+2. Create a virtual environment
+   - MacOS / Linux:
+     ```bash
+     python3 -m venv .venv
+     source ./.venv/bin/activate
+     ```
+   - Windows Powershell
+     ```Powershell
+     python -m venv .venv
+     .\.venv\Scripts\activate
+     ```
+
+3. Install psu-python locally in editable mode
+   ```bash
+   pip install -e .
+   ```

psu_python-0.2.3/src/psu_python.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/psu_python/__init__.py
+src/psu_python/dictionaries.py
+src/psu_python/lists.py
+src/psu_python/strings.py
+src/psu_python.egg-info/PKG-INFO
+src/psu_python.egg-info/SOURCES.txt
+src/psu_python.egg-info/dependency_links.txt
+src/psu_python.egg-info/requires.txt
+src/psu_python.egg-info/top_level.txt

psu_python-0.2.3/src/psu_python.egg-info/requires.txt

@@ -0,0 +1,5 @@
+
+[docs]
+sphinx>=4.0.0
+furo
+sphinx-autodoc-typehints

psu_python-0.1.0/PKG-INFO

@@ -1,15 +0,0 @@
-Metadata-Version: 2.4
-Name: psu-python
-Version: 0.1.0
-Summary:  A python package for abstracting python class methods behind a fully functional layer intended for educational use in CMPSC 131 at The Pennsylvania State University
-Author-email: Theodore Tasman <psupython@ttasman.com>
-License-Expression: GPL-3.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering
-Classifier: Operating System :: OS Independent
-Classifier: Natural Language :: English
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file

psu_python-0.1.0/pyproject.toml

@@ -1,23 +0,0 @@
-[build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name='psu-python'
-version='0.1.0'
-description=' A python package for abstracting python class methods behind a fully functional layer intended for educational use in CMPSC 131 at The Pennsylvania State University'
-authors=[
-    {name='Theodore Tasman', email='psupython@ttasman.com'}
-]
-license='GPL-3.0'
-readme='README.md'
-dependencies=[]
-classifiers=[
-    'Development Status :: 4 - Beta',
-    'Intended Audience :: Developers',
-    'Programming Language :: Python :: 3',
-    'Topic :: Scientific/Engineering',
-    'Operating System :: OS Independent',
-    'Natural Language :: English',
-]
-

psu_python-0.1.0/src/psu_python.egg-info/PKG-INFO

@@ -1,15 +0,0 @@
-Metadata-Version: 2.4
-Name: psu-python
-Version: 0.1.0
-Summary:  A python package for abstracting python class methods behind a fully functional layer intended for educational use in CMPSC 131 at The Pennsylvania State University
-Author-email: Theodore Tasman <psupython@ttasman.com>
-License-Expression: GPL-3.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering
-Classifier: Operating System :: OS Independent
-Classifier: Natural Language :: English
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file

psu_python-0.1.0/src/psu_python.egg-info/SOURCES.txt

@@ -1,7 +0,0 @@
-LICENSE
-pyproject.toml
-src/psu_python/__init__.py
-src/psu_python.egg-info/PKG-INFO
-src/psu_python.egg-info/SOURCES.txt
-src/psu_python.egg-info/dependency_links.txt
-src/psu_python.egg-info/top_level.txt