From fca7f60539a38de572104b8f2b005218e5bc5961 Mon Sep 17 00:00:00 2001 From: benlipkin Date: Mon, 23 Sep 2024 18:08:10 -0400 Subject: [PATCH] chore: added readme instructions to install from pypi --- README.md | 13 +++++++------ setup.py | 9 +++++++-- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8f9feac..2956e82 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,10 @@ Scaling inference thoughtfully is where the next breakthrough gains will come in ## Getting started -For now, install from source. Coming soon to `PyPi`. +Install directly from [PyPi](https://pypi.org/project/decoding/) ```bash -git clone git@github.com:benlipkin/decoding.git -cd decoding/ -python -m pip install . +python -m pip install decoding ``` See [Contributing](https://github.com/benlipkin/decoding#documentation) for how to build the dev and testing environment. @@ -64,13 +62,16 @@ We welcome community contributions. Open an issue or a pull request if you see a To get started with development, this library supports an automated build of the dev and testing env using [GNU Make](https://www.gnu.org/software/make/). ```bash -make env # install library in current env +# clone repo and install lib in current env +git clone git@github.com:benlipkin/decoding.git +cd decoding/ +make env ``` Before opening a PR, make sure all tests are passing: ```bash -make tests # run linting, type-checking, and unit-tests +make tests ``` diff --git a/setup.py b/setup.py index fa30356..15a4e4a 100644 --- a/setup.py +++ b/setup.py @@ -2,6 +2,8 @@ Setup file for the decoding library. """ +import pathlib + import setuptools core_requirements = [ @@ -19,11 +21,14 @@ "ruff==0.6.7", ] +with pathlib.Path("README.md").open(encoding="utf-8") as f: + readme = f.read() + setuptools.setup( name="decoding", version="0.1.0", - description="Composable LLM decoding algorithms", - long_description="See https://github.com/benlipkin/decoding for more information.", + description="Composable inference algorithms with LLMs and programmable logic", + long_description=readme, long_description_content_type="text/markdown", authors=["Ben Lipkin"], license="Apache 2.0",