gophermap 0.0.1__tar.gz → 0.0.2__tar.gz

gophermap-0.0.2/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: gophermap
+Version: 0.0.2
+Summary: A simple library for parsng Gophermaps
+Keywords: Gopher,Gophermap,Hypertext,library,Markup,parser,Small Web,smolweb
+Author: Dave Pearson
+Author-email: Dave Pearson <davep@davep.org>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Project-URL: Homepage, https://gophermap.davep.dev/
+Project-URL: Repository, https://github.com/davep/gophermap
+Project-URL: Documentation, https://gophermap.davep.dev/
+Project-URL: Source, https://github.com/davep/gophermap
+Project-URL: Issues, https://github.com/davep/gophermap/issues
+Project-URL: Discussions, https://github.com/davep/gophermap/discussions
+Description-Content-Type: text/markdown
+
+# gophermap - A simple library for parsing Gopher maps
+
+`gophermap` is a small and simple library that provides code for parsing
+Gopher responses.
+
+## Installation
+
+`gophermap` is [available from pypi](https://pypi.org/project/gophermap/)
+and can be installed with your package installer of choice.
+
+With `pip`:
+
+```shell
+pip install gophermap
+```
+
+With `uv`:
+
+```shell
+uv add gophermap
+```
+
+[//]: # (README.md ends here)

gophermap-0.0.2/README.md

@@ -0,0 +1,23 @@
+# gophermap - A simple library for parsing Gopher maps
+
+`gophermap` is a small and simple library that provides code for parsing
+Gopher responses.
+
+## Installation
+
+`gophermap` is [available from pypi](https://pypi.org/project/gophermap/)
+and can be installed with your package installer of choice.
+
+With `pip`:
+
+```shell
+pip install gophermap
+```
+
+With `uv`:
+
+```shell
+uv add gophermap
+```
+
+[//]: # (README.md ends here)

gophermap-0.0.2/pyproject.toml

@@ -0,0 +1,111 @@
+[project]
+name = "gophermap"
+version = "0.0.2"
+description = "A simple library for parsng Gophermaps"
+readme = "README.md"
+authors = [
+    { name = "Dave Pearson", email = "davep@davep.org" }
+]
+requires-python = ">=3.12"
+dependencies = []
+license = "MIT"
+keywords = [
+    "Gopher",
+    "Gophermap",
+    "Hypertext",
+    "library",
+    "Markup",
+    "parser",
+    "Small Web",
+    "smolweb",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://gophermap.davep.dev/"
+Repository = "https://github.com/davep/gophermap"
+Documentation = "https://gophermap.davep.dev/"
+Source = "https://github.com/davep/gophermap"
+Issues = "https://github.com/davep/gophermap/issues"
+Discussions = "https://github.com/davep/gophermap/discussions"
+
+[project.scripts]
+gophermap = "gophermap.__main__:parse_input"
+
+[build-system]
+requires = ["uv_build>=0.11.32,<0.12.0"]
+build-backend = "uv_build"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+
+[tool.pyright]
+venvPath="."
+venv=".venv"
+exclude=[".venv"]
+
+[dependency-groups]
+dev = [
+    "codespell>=2.4.3",
+    "mypy>=2.3.0",
+    "pre-commit>=4.6.0",
+    "ruff>=0.15.22",
+]
+docs = [
+    "mkdocs>=1.6.1,<2",
+    "mkdocs-material>=9.7.6",
+    "mkdocstrings[python]>=1.0.4",
+]
+test = [
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+]
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120
+
+[tool.coverage.run]
+omit = [
+     "tests/*"
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "class .*\\bProtocol\\):",
+    "@(abc\\.)?abstractmethod",
+]

gophermap-0.0.2/src/gophermap/__init__.py

@@ -0,0 +1,34 @@
+"""Provides tools for working with Gopher maps."""
+
+##############################################################################
+# Python imports.
+from importlib.metadata import version
+
+######################################################################
+# Main library information.
+__author__ = "Dave Pearson"
+__copyright__ = "Copyright 2026, Dave Pearson"
+__credits__ = ["Dave Pearson"]
+__maintainer__ = "Dave Pearson"
+__email__ = "davep@davep.org"
+__version__: str = version("gophermap")
+__licence__ = "MIT"
+
+##############################################################################
+# Local imports.
+from .exceptions import GopherMapError, NoFields
+from .gopher_map import GopherMap
+from .item import GopherItem
+from .item_type import ItemType
+
+##############################################################################
+# Exports.
+__all__ = [
+    "GopherItem",
+    "GopherMap",
+    "GopherMapError",
+    "ItemType",
+    "NoFields",
+]
+
+### __init__.py ends here

gophermap-0.0.2/src/gophermap/__main__.py

@@ -0,0 +1,25 @@
+"""A simple parser to show how the library works."""
+
+##############################################################################
+# Python imports.
+import fileinput
+
+##############################################################################
+# Local imports.
+from gophermap import GopherMap
+
+
+##############################################################################
+def parse_input() -> None:
+    """Parse the input from stdin or files and print the parsed Gopher map."""
+    with fileinput.input() as gopher_map:
+        for gopher_item in GopherMap("".join(gopher_map)).items:
+            print(f"{gopher_item!r}")
+
+
+##############################################################################
+if __name__ == "__main__":
+    parse_input()
+
+
+### __main__.py ends here

gophermap-0.0.2/src/gophermap/exceptions.py

@@ -0,0 +1,14 @@
+"""Exceptions for the library."""
+
+
+##############################################################################
+class GopherMapError(Exception):
+    """Base exception for all errors raised by the GopherMap library."""
+
+
+##############################################################################
+class NoFields(GopherMapError):
+    """Raised when a Gopher item has no fields."""
+
+
+### exceptions.py ends here

gophermap-0.0.2/src/gophermap/gopher_map.py

@@ -0,0 +1,57 @@
+"""Provides a class for parsing and holding a Gopher map."""
+
+##############################################################################
+# Python imports.
+from collections.abc import Iterator
+from functools import cached_property
+from typing import Final
+
+##############################################################################
+# Local imports.
+from .item import GopherItem
+
+##############################################################################
+EOF: Final = ".\r\n"
+"""The EOF marker for a Gopher map."""
+
+
+##############################################################################
+class GopherMap:
+    """A class for parsing and holding a Gopher map."""
+
+    def __init__(self, map_text: str) -> None:
+        """Initialise the Gopher map.
+
+        Args:
+            map_text: The text of the Gopher map.
+        """
+        self._raw = map_text
+        """The raw text of the Gopher map."""
+
+    @staticmethod
+    def _parse_map(map_text: str) -> Iterator[GopherItem]:
+        """Parse the Gopher map text into a list of Gopher items.
+
+        Args:
+            map_text: The text of the Gopher map.
+
+        Yields:
+            Gopher items.
+        """
+        for line in map_text.splitlines(keepends=True):
+            if line == EOF:
+                break
+            yield GopherItem(line)
+
+    @property
+    def raw(self) -> str:
+        """The raw text of the Gopher map."""
+        return self._raw
+
+    @cached_property
+    def items(self) -> tuple[GopherItem, ...]:
+        """The list of Gopher items in the map."""
+        return tuple(self._parse_map(self._raw))
+
+
+### gopher_map.py ends here

gophermap-0.0.2/src/gophermap/item.py

@@ -0,0 +1,75 @@
+"""Provides a class for holding an item in the Gopher map."""
+
+##############################################################################
+# Local imports.
+from .exceptions import NoFields
+from .item_type import ItemType
+
+
+##############################################################################
+class GopherItem:
+    """A class for holding an item in the Gopher map."""
+
+    def __init__(self, line: str) -> None:
+        """Initialise the Gopher item.
+
+        Args:
+            line: The line of text from the Gopher map.
+        """
+        if not line:
+            raise NoFields("The Gopher item line is empty.")
+        if "\t" not in line:
+            raise NoFields(f"The Gopher item line has no tab characters: {line!r}")
+        self._raw = line
+        """The raw text of the Gopher item."""
+        fields = line.rstrip("\r\n").split("\t")
+        self._type = ItemType(fields[0][0] or ItemType.INFO)
+        """The type of the Gopher item."""
+        self._display_text = fields[0][1:] if len(fields) > 0 else ""
+        """The display text of the Gopher item."""
+        self._selector = fields[1] if len(fields) > 1 else ""
+        """The selector of the Gopher item."""
+        self._host = fields[2] if len(fields) > 2 else ""
+        """The host of the Gopher item."""
+        self._port = int(fields[3]) if len(fields) > 3 and fields[3].isdigit() else 70
+        """The port of the Gopher item."""
+
+    @property
+    def raw(self) -> str:
+        """The raw text of the Gopher item."""
+        return self._raw
+
+    @property
+    def type(self) -> ItemType:
+        """The type of the Gopher item."""
+        return self._type
+
+    @property
+    def display_text(self) -> str:
+        """The display text of the Gopher item."""
+        return self._display_text
+
+    @property
+    def selector(self) -> str:
+        """The selector of the Gopher item."""
+        return self._selector
+
+    @property
+    def host(self) -> str:
+        """The host of the Gopher item."""
+        return self._host
+
+    @property
+    def port(self) -> int:
+        """The port of the Gopher item."""
+        return self._port
+
+    def __repr__(self) -> str:
+        """Return a string representation of the Gopher item."""
+        return (
+            f"GopherItem(type={self.type!r}, display_text={self.display_text!r}, "
+            f"selector={self.selector!r}, host={self.host!r}, port={self.port!r})"
+        )
+
+
+### item.py ends here

gophermap-0.0.2/src/gophermap/item_type.py

@@ -0,0 +1,69 @@
+"""Provides an enumeration for the different types of Gopher items."""
+
+##############################################################################
+# Future imports.
+from __future__ import annotations
+
+##############################################################################
+# Python imports.
+from enum import StrEnum
+
+
+##############################################################################
+class ItemType(StrEnum):
+    """An enumeration for the different types of Gopher items."""
+
+    TEXT = "0"
+    """A text file."""
+    MENU = "1"
+    """A menu."""
+    CSO = "2"
+    """A CSO phone book."""
+    ERROR = "3"
+    """An error message."""
+    BINHEX = "4"
+    """A BinHexed file."""
+    DOS_FILE = "5"
+    """A DOS file."""
+    UUENCODED = "6"
+    """A uuencoded file."""
+    INDEX_SEARCH = "7"
+    """An index search."""
+    TELNET = "8"
+    """A telnet session."""
+    BINARY = "9"
+    """A binary file."""
+    INFO = "i"
+    """An informational message."""
+    GIF = "g"
+    """A GIF image."""
+    IMAGE = "I"
+    """An image file."""
+    HTML = "h"
+    """An HTML file."""
+    DOCUMENT = "d"
+    """A document file."""
+    AUDIO = "s"
+    """An audio file."""
+    PDF = "P"
+    """A PDF file."""
+    XML = "X"
+    """An XML file."""
+    UNKNOWN = "unknown"
+    """An unknown type."""
+
+    @classmethod
+    def _missing_(cls, value: object) -> ItemType:
+        """Handle missing values in the enumeration.
+
+        Args:
+            value: The value that is missing.
+
+        Returns:
+            The corresponding ItemType for the missing value.
+        """
+        assert isinstance(value, str)
+        return ItemType.UNKNOWN
+
+
+### item_type.py ends here

gophermap-0.0.1/PKG-INFO

@@ -1,9 +0,0 @@
-Metadata-Version: 2.3
-Name: gophermap
-Version: 0.0.1
-Summary: Coming soon
-Author: Dave Pearson
-Author-email: Dave Pearson <davep@davep.org>
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-

gophermap-0.0.1/pyproject.toml

@@ -1,23 +0,0 @@
-[project]
-name = "gophermap"
-version = "0.0.1"
-description = "Coming soon"
-readme = "README.md"
-authors = [
-    { name = "Dave Pearson", email = "davep@davep.org" }
-]
-requires-python = ">=3.12"
-dependencies = []
-
-[project.scripts]
-gophermap = "gophermap:main"
-
-[build-system]
-requires = ["uv_build>=0.11.32,<0.12.0"]
-build-backend = "uv_build"
-
-[[tool.uv.index]]
-name = "testpypi"
-url = "https://test.pypi.org/simple/"
-publish-url = "https://test.pypi.org/legacy/"
-explicit = true

gophermap-0.0.1/src/gophermap/__init__.py

@@ -1,2 +0,0 @@
-def main() -> None:
-    print("Hello from gophermap!")