nosible 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

nosible/utils/json_tools.py

@@ -14,7 +14,7 @@ except ImportError:
 # --------------------------------------------------------------------------------------------------------------
 
 
-def json_dumps(obj: object) -> Union[bytes, str]:
+def json_dumps(obj: object) -> str:
     """
     Returns a JSON byte-string if using orjson, else a unicode str.
 
@@ -36,7 +36,37 @@ def json_dumps(obj: object) -> Union[bytes, str]:
 
     Examples
     --------
+    # Standard dict serialization (no orjson)
+    >>> _use_orjson = False
+    >>> json_dumps({"a": 1})
+    '{"a":1}'
+
+    # List serialization
+    >>> _use_orjson = False
+    >>> json_dumps([1, 2, 3])
+    '[1,2,3]'
+
+    # orjson path returns unicode str
+    >>> import orjson
+    >>> _use_orjson = True
+    >>> orjson.dumps = lambda o: b'{"b":2}'
+    >>> json_dumps({"b": 2})
+    '{"b":2}'
 
+    # Non-str dict keys are coerced to str when using orjson
+    >>> _use_orjson = True
+    >>> orjson.dumps = lambda o: b'{"1":"one"}'
+    >>> json_dumps({1: "one"})
+    '{"1":"one"}'
+
+    # Error path: un-serializable object
+    >>> _use_orjson = False
+    >>> class Bad: pass
+    >>> try:
+    ...     json_dumps(Bad())
+    ... except RuntimeError as e:
+    ...     "Failed to serialize object to JSON" in str(e)
+    '{"1":"one"}'
     """
     try:
         if _use_orjson:
@@ -81,7 +111,7 @@ def json_loads(s: Union[bytes, str]) -> dict:
     # Standard library path (disable orjson)
     >>> _use_orjson = False
     >>> json_dumps({'a': 1})
-    '{"a":1}'
+    '{"1":"one"}'
 
     # orjson path with monkey-patched dumping
     >>> _use_orjson = True
@@ -115,3 +145,22 @@ def json_loads(s: Union[bytes, str]) -> dict:
     except Exception as e:
         # Optionally, you can log the error here
         raise RuntimeError(f"Failed to deserialize JSON: {e}") from e
+
+
+def print_dict(dict: dict) -> str:
+    """
+    Print a dictionary in a readable format.
+
+    Parameters
+    ----------
+    d : dict
+        The dictionary to print.
+
+    Returns
+    -------
+    None
+        This function does not return anything; it prints the dictionary to stdout.
+    """
+    if _use_orjson:
+        return orjson.dumps(dict, option=orjson.OPT_INDENT_2).decode("utf-8")
+    return json.dumps(dict, indent=2)

nosible/utils/question_builder.py

@@ -0,0 +1,131 @@
+import random
+
+COMPANIES = [
+    "Apple Inc.",
+    "Microsoft Corporation",
+    "Amazon.com, Inc.",
+    "Alphabet Inc.",
+    "Meta Platforms, Inc.",
+    "Tesla, Inc.",
+    "Berkshire Hathaway Inc.",
+    "NVIDIA Corporation",
+    "JPMorgan Chase & Co.",
+    "Johnson & Johnson",
+    "Walmart Inc.",
+    "Visa Inc.",
+    "Mastercard Incorporated",
+    "Procter & Gamble Co.",
+    "UnitedHealth Group Incorporated",
+    "Bank of America Corporation",
+    "Home Depot, Inc.",
+    "Nestlé S.A.",
+    "Samsung Electronics Co., Ltd.",
+    "LVMH Moët Hennessy – Louis Vuitton",
+    "ASML Holding N.V.",
+    "Exxon Mobil Corporation",
+    "Intel Corporation",
+    "Pfizer Inc.",
+    "The Coca-Cola Company",
+    "PepsiCo, Inc.",
+    "Chevron Corporation",
+    "Merck & Co., Inc.",
+    "Novartis International AG",
+    "Toyota Motor Corporation",
+    "Oracle Corporation",
+    "Cisco Systems, Inc.",
+    "Adobe Inc.",
+    "Salesforce, Inc.",
+    "Netflix, Inc.",
+    "International Business Machines Corporation (IBM)",
+    "The Walt Disney Company",
+    "HSBC Holdings plc",
+    "McDonald's Corporation",
+    "Nike, Inc.",
+    "Qualcomm Incorporated",
+    "Roche Holding AG",
+    "SAP SE",
+    "Abbott Laboratories",
+    "Costco Wholesale Corporation",
+    "Broadcom Inc.",
+    "Accenture plc",
+    "Chevron Corporation",
+    "Texas Instruments Incorporated",
+    "Unilever PLC"
+]
+
+THINGS_TO_KNOW = [
+    "Company name and branding",
+    "Founding date and history",
+    "Founders and key executives",
+    "Headquarters and global offices",
+    "Mission, vision, and values",
+    "Core products and services",
+    "Business model and revenue streams",
+    "Annual revenue and growth rate",
+    "Profit margins (gross, operating, net)",
+    "Market capitalization and valuation",
+    "Key financial ratios (P/E, ROE, ROI)",
+    "Stock price history and recent performance",
+    "Major investors and shareholder structure",
+    "Recent mergers, acquisitions, or divestitures",
+    "R&D spending and innovation pipeline",
+    "Competitive landscape and main rivals",
+    "Market share by region or segment",
+    "Customer segments and target markets",
+    "Pricing strategy and positioning",
+    "Supply chain structure and partners",
+    "Distribution channels and logistics",
+    "Marketing and advertising strategies",
+    "Brand perception and reputation",
+    "ESG (Environmental, Social, Governance) scores",
+    "Sustainability initiatives and impact",
+    "Corporate culture and employee count",
+    "Employee satisfaction and turnover rates",
+    "Leadership and governance practices",
+    "Regulatory environment and compliance record",
+    "Key risks and litigation history",
+    "Recent news, press releases, and media coverage",
+    "Patents, trademarks, and IP portfolio",
+    "Digital transformation and tech stack",
+    "Website traffic and social media metrics",
+    "Mobile app usage and customer reviews",
+    "Partnerships and strategic alliances",
+    "Future outlook and analyst recommendations",
+]
+
+JOB_TITLES = [
+    "Chief Executive Officer (CEO)",
+    "Chief Financial Officer (CFO)",
+    "Chief Operating Officer (COO)",
+    "Chief Technology Officer (CTO)",
+    "Chief Marketing Officer (CMO)",
+    "Head of Investor Relations",
+    "Director of Corporate Strategy",
+    "Business Development Manager",
+    "Product Manager",
+    "Marketing Manager",
+    "Brand Manager",
+    "Financial Analyst",
+    "Equity Research Analyst",
+    "Market Research Analyst",
+    "Consultant",
+    "Venture Capital Associate",
+    "Private Equity Associate",
+    "Operations Manager",
+    "Supply Chain Manager",
+    "Human Resources Manager",
+    "Sustainability Officer",
+    "Compliance Officer",
+    "Legal Counsel",
+    "Risk Manager",
+    "Data Analyst",
+    "IT Manager",
+    "Sales Director",
+    "Account Manager",
+    "Customer Success Manager",
+    "Public Relations Manager"
+]
+
+def _get_question():
+    return (f"I am a {random.choice(JOB_TITLES)} and I want to know {random.choice(THINGS_TO_KNOW)}"
+            f"about {random.choice(COMPANIES)}")

nosible/utils/rate_limiter.py

@@ -10,40 +10,46 @@ log = logging.getLogger(__name__)
 
 PLAN_RATE_LIMITS = {
     "test": {
-        # Per minute limit, then per day.
-        "visit": [(1, 60), (10, 24 * 3600)],
-        "slow": [(1, 60), (10, 24 * 3600)],
-        "fast": [(10, 60), (100, 24 * 3600)],
+        # Per minute limit, then per month.
+        "visit": [(60, 60), (300, 24 * 3600 * 30)],
+        "slow": [(60, 60), (300, 24 * 3600 * 30)],
+        "fast": [(60, 60), (3000, 24 * 3600 * 30)],
     },
     "basic": {
-        "visit": [(1, 60), (100, 24 * 3600)],
-        "slow": [(1, 60), (100, 24 * 3600)],
-        "fast": [(10, 60), (1000, 24 * 3600)],
+        "visit": [(60, 60), (1400, 24 * 3600 * 30)],
+        "slow": [(60, 60), (1400, 24 * 3600 * 30)],
+        "fast": [(60, 60), (14_000, 24 * 3600 * 30)],
     },
     "pro": {
-        "visit": [(1, 60), (250, 24 * 3600)],
-        "slow": [(1, 60), (250, 24 * 3600)],
-        "fast": [(10, 60), (5_000, 24 * 3600)],
+        "visit": [(60, 60), (6700, 24 * 3600 * 30)],
+        "slow": [(60, 60), (6700, 24 * 3600 * 30)],
+        "fast": [(60, 60), (67_000, 24 * 3600 * 30)],
     },
     "pro+": {
-        "visit": [(2, 60), (500, 24 * 3600)],
-        "slow": [(2, 60), (500, 24 * 3600)],
-        "fast": [(10, 60), (10_000, 24 * 3600)],
+        "visit": [(60, 60), (32_000, 24 * 3600 * 30)],
+        "slow": [(60, 60), (32_000, 24 * 3600 * 30)],
+        "fast": [(60, 60), (320_000, 24 * 3600 * 30)],
     },
     "bus": {
-        "visit": [(2, 60), (1000, 24 * 3600)],
-        "slow": [(2, 60), (1000, 24 * 3600)],
-        "fast": [(35, 60), (50_000, 24 * 3600)],
+        "visit": [(60, 60), (200_000, 24 * 3600 * 30)],
+        "slow": [(60, 60), (200_000, 24 * 3600 * 30)],
+        "fast": [(60, 60), (2_000_000, 24 * 3600 * 30)],
     },
     "bus+": {
-        "visit": [(3, 60), (2000, 24 * 3600)],
-        "slow": [(3, 60), (2000, 24 * 3600)],
-        "fast": [(100, 60), (100_000, 24 * 3600)],
+        "visit": [(60, 60), (500_000, 24 * 3600 * 30)],
+        "slow": [(60, 60), (500_000, 24 * 3600 * 30)],
+        "fast": [(120, 60), (5_000_000, 24 * 3600 * 30)],
     },
     "ent": {
-        "visit": [(5, 60), (5000, 24 * 3600)],
-        "slow": [(5, 60), (5000, 24 * 3600)],
-        "fast": [(400, 60), (500_000, 24 * 3600)],
+        "visit": [(60, 60), (1_500_000, 24 * 3600 * 30)],
+        "slow": [(60, 60), (1_500_000, 24 * 3600 * 30)],
+        "fast": [(360, 60), (15_000_000, 24 * 3600 * 30)],
+    },
+    # This plan is used for testing in the package
+    "chat": {
+        "visit": [(60, 60), (1_500_000, 24 * 3600 * 30)],
+        "slow": [(60, 60), (1_500_000, 24 * 3600 * 30)],
+        "fast": [(360, 60), (15_000_000, 24 * 3600 * 30)],
     },
 }
 
@@ -121,7 +127,7 @@ class RateLimiter:
         --------
         >>> rl = RateLimiter(1, 10.0)
         >>> rl.acquire()  # first call always passes
-        >>> # second call within 10 seconds will block until the window resets
+        >>> # Second call within 10 seconds will block until the window resets
         >>> start = time.monotonic(); rl.acquire(); end = time.monotonic()
         >>> end - start >= 10.0
         True
@@ -160,7 +166,7 @@ class RateLimiter:
         >>> rl = RateLimiter(1, 10.0)
         >>> rl.try_acquire()
         True
-        >>> # immediately calling again will fail
+        >>> # Immediately calling again will fail
         >>> rl.try_acquire()
         False
         """

{nosible-0.1.8.dist-info → nosible-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nosible
-Version: 0.1.8
+Version: 0.1.9
 Summary: Python client for the NOSIBLE Search API
 Home-page: https://github.com/NosibleAI/nosible
 Author: Stuart Reid, Matthew Dicks, Richard Taylor, Gareth Warburton
@@ -77,26 +77,11 @@ pip install nosible
 * tantivy
 * openai
 
-### ⚙️ Configuration
-
-You can specify a custom base URL for all endpoints (e.g., OpenRouter, Google, or your own proxy):
-
-```python
-from nosible import Nosible
-
-client = Nosible(
-    nosible_api_key="basic|abcd1234...",
-    llm_api_key="sk-...",
-    base_url="https://api.openrouter.ai/v1"
-)
-```
-
 ### 🔑 Authentication
 
-1. Sign in to nosible.ai and grab your free API key.
+1. Sign in to [NOSIBLE.AI](https://www.nosible.ai/) and grab your free API key.
 2. Set it as an environment variable or pass directly:
 
-
 On Windows
 
 ```powershell
@@ -250,7 +235,7 @@ with Nosible(nosible_api_key="basic|abcd1234...") as client:
 
 #### Sentiment Analysis
 
-Compute sentiment for a single result (Uses GPT-4o; requires LLM API key):
+Compute sentiment for a single result (uses GPT-4o; requires an LLM API key):
 
 ```python
 from nosible import Nosible
@@ -297,6 +282,10 @@ with Nosible(nosible_api_key="basic|abcd1234...") as client:
     rs_ndjson = ResultSet.from_ndjson("all_news.ndjson")
 ```
 
+#### More Examples
+
+For more examples, checkout `/examples` for in-depth usage of the NOSIBLE Client Package
+
 ### 📡 Swagger Docs
 
 You can find online endpoints to the NOSIBLE Search API Swagger Docs
@@ -309,33 +298,8 @@ Inspect your current limits at runtime:
 ```python
 client.get_ratelimits()
 ```
-Default limits by plan:
-
-| Plan           | Period     | Fast Searches | URL Visits | Slow Searches | Cost     | CPM  |
-|----------------|------------|---------------|------------|---------------|----------|------|
-| **Free**       | Monthly    | 3,000         | 300        | 300           | \$0      | $0   |
-|                | Daily      | 100           | 10         | 10            |          |      |
-|                | Per-Minute | 10            | 1          | 1             |          |      |
-| **Basic**      | Monthly    | 30,000        | 3,000      | 3,000         | \$120    | $4   |
-|                | Daily      | 1,000         | 100        | 100           |          |      |
-|                | Per-Minute | 10            | 1          | 1             |          |      |
-| **Pro**        | Monthly    | 150,000       | 7,500      | 7,500         | \$450    | $3   |
-|                | Daily      | 5,000         | 250        | 250           |          |      |
-|                | Per-Minute | 10            | 1          | 1             |          |      |
-| **Pro+**       | Monthly    | 300,000       | 15,000     | 15,000        | \$750    | $2.5 |
-|                | Daily      | 10,000        | 500        | 500           |          |      |
-|                | Per-Minute | 10            | 2          | 1             |          |      |
-| **Business**   | Monthly    | 1,500,000     | 30,000     | 30,000        | \$3,000  | $2   |
-|                | Daily      | 50,000        | 1,000      | 1,000         |          |      |
-|                | Per-Minute | 35            | 2          | 2             |          |      |
-| **Business+**  | Monthly    | 3,000,000     | 60,000     | 60,000        | \$4,500  | $1.5 |
-|                | Daily      | 100,000       | 2,000      | 2,000         |          |      |
-|                | Per-Minute | 100           | 3          | 3             |          |      |
-| **Enterprise** | Monthly    | 15,000,000    | 150,000    | 150,000       | \$15,000 | $1   |
-|                | Daily      | 500,000       | 5,000      | 5,000         |          |      |
-|                | Per-Minute | 400           | 5          | 5             |          |      |
-
-*All endpoints are automatically throttled
+
+Or you can view them on the [docs](https://nosible-py.readthedocs.io/en/latest/rate_limits.html).
 
 ---
 

nosible-0.1.9.dist-info/RECORD

@@ -0,0 +1,17 @@
+nosible/__init__.py,sha256=11QmG9Wjprp_zB0VnPxGjqKwHmaoB0hoT8AGO6cGVMM,1426
+nosible/nosible_client.py,sha256=LbbzQHSvINnHRetIlAekXbZAWe_yF4JaNsjqDbYVsuw,70281
+nosible/classes/result.py,sha256=mSMMKSo3EoZCSPYM5PGezsBQQYgW0jFnDtpOwZOAT3s,17251
+nosible/classes/result_set.py,sha256=T-AYXeKgEy5fqEo4gGBlzqszo9F-XgczwspLF-Nm0Jk,52164
+nosible/classes/search.py,sha256=hmIgK4pFcbCgjLypEWY0s8I6l914_xppNyTV4PWN-vo,10608
+nosible/classes/search_set.py,sha256=4L2qO_IKqlUebvxNJERxjXNiUKtolw7JhgFtt1QqEHk,9790
+nosible/classes/snippet.py,sha256=5Av0cXjOL-8X6H8oFunC36DUyWiFLLsl7FfPJ7cYwVU,4988
+nosible/classes/snippet_set.py,sha256=1SZUEq6zRcBT3N8BKbFPml5pt_WSCybIjMpTw8PTz4E,5093
+nosible/classes/web_page.py,sha256=fe-cfDL-AmQRMdBO37jWh1K6BsH_K_VWBBfBzFRV3KM,7149
+nosible/utils/json_tools.py,sha256=UB8xuk9UoLDd4XD-M0CuuuKToOfMOtPmd7b5gT-SHaY,4550
+nosible/utils/question_builder.py,sha256=S3eCb0Dsg0_1kyUmp2hxYnxH4Yq_tUi-HkB8owUB60E,4063
+nosible/utils/rate_limiter.py,sha256=qr0Tg-3wVcw95FyQv3gbZhbf-_QY9zKdkIE4FSLFSBo,5400
+nosible-0.1.9.dist-info/licenses/LICENSE,sha256=8ifsV4DrsiKi8KVBFy8SBb3KXPXhofE3pYq07q1TSCQ,1117
+nosible-0.1.9.dist-info/METADATA,sha256=ka83CR6XMeSaGVNQNig0VE6aCCWdjrow6dKpf6RLbuE,9486
+nosible-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nosible-0.1.9.dist-info/top_level.txt,sha256=mOconHuKcNJ1jTAj3DapQP_xB8YOmjTMyHg5txKH3uA,8
+nosible-0.1.9.dist-info/RECORD,,

nosible-0.1.8.dist-info/RECORD

@@ -1,16 +0,0 @@
-nosible/__init__.py,sha256=11QmG9Wjprp_zB0VnPxGjqKwHmaoB0hoT8AGO6cGVMM,1426
-nosible/nosible_client.py,sha256=jNBc8iNXRCZLHpZUfkRh8paeBph6BcZF5fLGN1R3h-A,69072
-nosible/classes/result.py,sha256=EqhdO4qkSfflE1DSRYnNZpOBJ3F2ZGyJNN5KOOj4MkQ,17929
-nosible/classes/result_set.py,sha256=26NLzUlKOhsb4TpIpEROCSYiJtRXrsrrJmXzVEa8DgA,51148
-nosible/classes/search.py,sha256=ICH4AJgUKO4jSlqU2N5LLAVvdbNza1VOJ08PW2FnHIk,10855
-nosible/classes/search_set.py,sha256=q4OWMy_ptRjc9sc_FMEYhMjEg5ZAS6Wr3bFAyt0F_Rw,9136
-nosible/classes/snippet.py,sha256=SEYuRpV0QGWNHLGPhyTO0kjOv4QrCrlH1-9X_DAuAYs,5114
-nosible/classes/snippet_set.py,sha256=lWWayADvWhzzYwJKtVkLOL0guFCnvZp82VQkiC_ESkk,4941
-nosible/classes/web_page.py,sha256=DJnO7NYVkrm4V244oUuWVJVHe4SBQycxqC2T3WLFR54,9017
-nosible/utils/json_tools.py,sha256=pG1ANpclklc01DWJfoinnDA3M0XX2JhyTVd_5qK3xnA,3308
-nosible/utils/rate_limiter.py,sha256=N8-GsueWb6VbfKu4UI94lM6yyLlZY-fxzTJ9NQdhZW4,4986
-nosible-0.1.8.dist-info/licenses/LICENSE,sha256=8ifsV4DrsiKi8KVBFy8SBb3KXPXhofE3pYq07q1TSCQ,1117
-nosible-0.1.8.dist-info/METADATA,sha256=-KfyVV67hUF7RC298RDzepva0WeockH0AZgQqaw9ffw,11803
-nosible-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nosible-0.1.8.dist-info/top_level.txt,sha256=mOconHuKcNJ1jTAj3DapQP_xB8YOmjTMyHg5txKH3uA,8
-nosible-0.1.8.dist-info/RECORD,,