pymethodbook 0.1.0__tar.gz → 0.2.0__tar.gz

{pymethodbook-0.1.0 → pymethodbook-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pymethodbook
-Version: 0.1.0
+Version: 0.2.0
 Summary: A terminal-first reference tool for Python's built-in methods — curated descriptions, runnable examples, and a searchable CLI.
 Project-URL: Homepage, https://github.com/logeshchandrasekar/pymethodbook
 Project-URL: Repository, https://github.com/logeshchandrasekar/pymethodbook
@@ -64,13 +64,16 @@ search("copy")
 
 - `list` — 11 methods
 - `dict` — 11 methods
+- `str` — 12 methods
+- `set` — 12 methods
+- `tuple` — 2 methods (tuples are immutable — count and index are genuinely the only two)
 
-More types (`str`, `set`, `tuple`) are on the roadmap — see [ROADMAP.md](ROADMAP.md).
+More types (`str`, `set`, `tuple`) are on the roadmap — see [ROADMAP.md](https://github.com/logeshchandrasekar/pymethodbook/blob/main/ROADMAP.md)
 
 ## Contributing
 
-Adding a method doesn't require touching any Python code — see [CONTRIBUTING.md](CONTRIBUTING.md).
+Adding a method doesn't require touching any Python code — see [CONTRIBUTING.md](https://github.com/logeshchandrasekar/pymethodbook/blob/main/CONTRIBUTING.md)
 
 ## License
 
-MIT — see [LICENSE](LICENSE).
+MIT — see [LICENSE](https://github.com/logeshchandrasekar/pymethodbook/blob/main/LICENSE)

{pymethodbook-0.1.0 → pymethodbook-0.2.0}/README.md

@@ -36,13 +36,16 @@ search("copy")
 
 - `list` — 11 methods
 - `dict` — 11 methods
+- `str` — 12 methods
+- `set` — 12 methods
+- `tuple` — 2 methods (tuples are immutable — count and index are genuinely the only two)
 
-More types (`str`, `set`, `tuple`) are on the roadmap — see [ROADMAP.md](ROADMAP.md).
+More types (`str`, `set`, `tuple`) are on the roadmap — see [ROADMAP.md](https://github.com/logeshchandrasekar/pymethodbook/blob/main/ROADMAP.md)
 
 ## Contributing
 
-Adding a method doesn't require touching any Python code — see [CONTRIBUTING.md](CONTRIBUTING.md).
+Adding a method doesn't require touching any Python code — see [CONTRIBUTING.md](https://github.com/logeshchandrasekar/pymethodbook/blob/main/CONTRIBUTING.md)
 
 ## License
 
-MIT — see [LICENSE](LICENSE).
+MIT — see [LICENSE](https://github.com/logeshchandrasekar/pymethodbook/blob/main/LICENSE)

{pymethodbook-0.1.0 → pymethodbook-0.2.0}/ROADMAP.md

@@ -16,6 +16,8 @@ Currently supported types: `list`, `dict` (v1).
 ## v5
 - Community-contributed "type packs" — a plugin format so others can add coverage (e.g. pandas) without touching core
 
+## Shipped
+- v0.2.0 — Full `str`, `set`, and `tuple` coverage
+
 ## Ongoing
-- Expanding `str`, `set`, `tuple` coverage
-- Improving example quality based on GitHub issues and requests.
+- Improving example quality based on GitHub issues and requests

{pymethodbook-0.1.0 → pymethodbook-0.2.0}/pymethodbook/__init__.py

@@ -2,7 +2,7 @@
 from .core import get_method, load_type, search as _search
 from .render import render_method, render_type_table, render_search_results
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 
 def explain(type_name, method_name):

pymethodbook-0.2.0/pymethodbook/data/set.json

@@ -0,0 +1,74 @@
+{
+  "add": {
+    "signature": "set.add(item)",
+    "description": "Adds a single item to the set, in place; has no effect if it's already present.",
+    "example": "s = {1, 2}\ns.add(3)\n# s -> {1, 2, 3}",
+    "category": "mutating"
+  },
+  "remove": {
+    "signature": "set.remove(item)",
+    "description": "Removes item from the set; raises KeyError if it isn't present.",
+    "example": "s = {1, 2, 3}\ns.remove(2)\n# s -> {1, 3}",
+    "category": "mutating"
+  },
+  "discard": {
+    "signature": "set.discard(item)",
+    "description": "Removes item from the set if present; does nothing (no error) if it isn't.",
+    "example": "s = {1, 2}\ns.discard(5)\n# s -> {1, 2}, no error even though 5 wasn't present",
+    "category": "mutating"
+  },
+  "pop": {
+    "signature": "set.pop()",
+    "description": "Removes and returns an arbitrary item from the set (sets are unordered, so you don't control which one).",
+    "example": "s = {1, 2, 3}\nitem = s.pop()\n# item -> one of 1, 2, or 3, removed from s",
+    "category": "mutating"
+  },
+  "clear": {
+    "signature": "set.clear()",
+    "description": "Removes all items from the set, in place.",
+    "example": "s = {1, 2}\ns.clear()\n# s -> set()",
+    "category": "mutating"
+  },
+  "union": {
+    "signature": "set.union(other)",
+    "description": "Returns a new set containing all items from both sets.",
+    "example": "{1, 2}.union({2, 3})\n# -> {1, 2, 3}",
+    "category": "read-only"
+  },
+  "intersection": {
+    "signature": "set.intersection(other)",
+    "description": "Returns a new set containing only items present in both sets.",
+    "example": "{1, 2, 3}.intersection({2, 3, 4})\n# -> {2, 3}",
+    "category": "read-only"
+  },
+  "difference": {
+    "signature": "set.difference(other)",
+    "description": "Returns a new set with items in this set but not in other.",
+    "example": "{1, 2, 3}.difference({2})\n# -> {1, 3}",
+    "category": "read-only"
+  },
+  "symmetric_difference": {
+    "signature": "set.symmetric_difference(other)",
+    "description": "Returns a new set with items in either set but not in both.",
+    "example": "{1, 2}.symmetric_difference({2, 3})\n# -> {1, 3}",
+    "category": "read-only"
+  },
+  "issubset": {
+    "signature": "set.issubset(other)",
+    "description": "Returns True if every item in this set is also in other.",
+    "example": "{1, 2}.issubset({1, 2, 3})\n# -> True",
+    "category": "read-only"
+  },
+  "issuperset": {
+    "signature": "set.issuperset(other)",
+    "description": "Returns True if this set contains every item in other.",
+    "example": "{1, 2, 3}.issuperset({1, 2})\n# -> True",
+    "category": "read-only"
+  },
+  "copy": {
+    "signature": "set.copy()",
+    "description": "Returns a shallow copy of the set as a new, separate object.",
+    "example": "s = {1, 2}\ns2 = s.copy()\n# s2 -> {1, 2}, separate object",
+    "category": "read-only"
+  }
+}

pymethodbook-0.2.0/pymethodbook/data/str.json

@@ -0,0 +1,74 @@
+{
+  "strip": {
+    "signature": "str.strip(chars=None)",
+    "description": "Removes leading and trailing whitespace (or the given characters) and returns a new string.",
+    "example": "'  hello  '.strip()\n# -> 'hello'",
+    "category": "read-only"
+  },
+  "lower": {
+    "signature": "str.lower()",
+    "description": "Returns a new string with all characters converted to lowercase.",
+    "example": "'HELLO'.lower()\n# -> 'hello'",
+    "category": "read-only"
+  },
+  "upper": {
+    "signature": "str.upper()",
+    "description": "Returns a new string with all characters converted to uppercase.",
+    "example": "'hello'.upper()\n# -> 'HELLO'",
+    "category": "read-only"
+  },
+  "split": {
+    "signature": "str.split(sep=None)",
+    "description": "Splits the string into a list of substrings using sep as the delimiter (whitespace by default).",
+    "example": "'a,b,c'.split(',')\n# -> ['a', 'b', 'c']",
+    "category": "read-only"
+  },
+  "join": {
+    "signature": "str.join(iterable)",
+    "description": "Joins the items of an iterable into a single string, using this string as the separator.",
+    "example": "','.join(['a', 'b', 'c'])\n# -> 'a,b,c'",
+    "category": "read-only"
+  },
+  "replace": {
+    "signature": "str.replace(old, new)",
+    "description": "Returns a new string with all occurrences of old replaced by new.",
+    "example": "'hello'.replace('l', 'L')\n# -> 'heLLo'",
+    "category": "read-only"
+  },
+  "startswith": {
+    "signature": "str.startswith(prefix)",
+    "description": "Returns True if the string starts with prefix.",
+    "example": "'hello'.startswith('he')\n# -> True",
+    "category": "read-only"
+  },
+  "endswith": {
+    "signature": "str.endswith(suffix)",
+    "description": "Returns True if the string ends with suffix.",
+    "example": "'hello'.endswith('lo')\n# -> True",
+    "category": "read-only"
+  },
+  "find": {
+    "signature": "str.find(sub)",
+    "description": "Returns the lowest index where sub is found, or -1 if not found — never raises an error.",
+    "example": "'hello'.find('l')\n# -> 2",
+    "category": "read-only"
+  },
+  "format": {
+    "signature": "str.format(*args, **kwargs)",
+    "description": "Returns a new formatted string, filling {} placeholders from the given args and kwargs.",
+    "example": "'{}, {}!'.format('Hello', 'World')\n# -> 'Hello, World!'",
+    "category": "read-only"
+  },
+  "isdigit": {
+    "signature": "str.isdigit()",
+    "description": "Returns True if every character is a digit and the string is non-empty.",
+    "example": "'123'.isdigit()\n# -> True",
+    "category": "read-only"
+  },
+  "isalpha": {
+    "signature": "str.isalpha()",
+    "description": "Returns True if every character is alphabetic and the string is non-empty.",
+    "example": "'abc'.isalpha()\n# -> True",
+    "category": "read-only"
+  }
+}

pymethodbook-0.2.0/pymethodbook/data/tuple.json

@@ -0,0 +1,14 @@
+{
+  "count": {
+    "signature": "tuple.count(value)",
+    "description": "Returns how many times value appears in the tuple.",
+    "example": "(1, 2, 2, 3).count(2)\n# -> 2",
+    "category": "read-only"
+  },
+  "index": {
+    "signature": "tuple.index(value)",
+    "description": "Returns the index of the first occurrence of value; raises ValueError if not found.",
+    "example": "(10, 20, 30).index(20)\n# -> 1",
+    "category": "read-only"
+  }
+}

{pymethodbook-0.1.0 → pymethodbook-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pymethodbook"
-version = "0.1.0"
+version = "0.2.0"
 description = "A terminal-first reference tool for Python's built-in methods — curated descriptions, runnable examples, and a searchable CLI."
 readme = "README.md"
 requires-python = ">=3.8"

{pymethodbook-0.1.0 → pymethodbook-0.2.0}/tests/test_core.py

@@ -5,10 +5,10 @@ from pymethodbook.core import (
 )
 
 
-def test_available_types_includes_list_and_dict():
+def test_available_types_includes_all_core_types():
     types = available_types()
-    assert "list" in types
-    assert "dict" in types
+    for expected in ("list", "dict", "str", "set", "tuple"):
+        assert expected in types
 
 
 def test_load_type_returns_dict_with_entries():