From e564421561294e5cf232fdbde67a30252103d170 Mon Sep 17 00:00:00 2001 From: kayvane1 Date: Mon, 4 Dec 2023 14:57:51 +0000 Subject: [PATCH] feat: add pypi --- README.md | 9 ++++++++- pyproject.toml | 2 +- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 49509a6..7a38fb7 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,13 @@ Notes: - This repo is under active development and is not yet ready for production use. - Pypi is currently not accepting new registrations, so this package is not yet available on Pypi. Once Pypi is accepting new registrations, this package will be available on Pypi. +## Installation +To get started, install the package using pip: + +```bash +pip install brave-search +``` + ## Usage The module supports both synchronous and asynchronous requests. Your Brave API key can either be passed as an environment variable under `BRAVE_API_KEY` or as an argument to the Brave class. @@ -137,7 +144,7 @@ num_results = 10 search_results = brave.search(q=query, goggles_id=thought_leadership, count=num_results) ``` -## Installation +## Local Installation This package uses Poetry for dependency management. To start developing here, you need to install Poetry diff --git a/pyproject.toml b/pyproject.toml index ec30bdc..fda7b46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [tool.poetry] -name = "brave" +name = "brave-search" version = "0.1.0" description = "Brave Search API wrapper" authors = ["Kayvane Shakerifar"]