Skip to content

Commit

Permalink
minor changes in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nsosio committed Dec 26, 2023
1 parent e51fdcc commit 802f929
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<h1 align="center">🚀 Prem Python SDK</h1>
<p align="center">The Prem Python SDK is a Python library for interacting with the <a href="https://github.com/premAI-io/prem-saas">Prem API</a></p>

[![PyPI version](https://img.shields.io/pypi/v/premai.svg)](https://pypi.org/project/premai/)
[![GitHub contributors](https://img.shields.io/github/contributors/premAI-io/prem-python-sdk.svg)](https://github.com/premAI-io/prem-python-sdk/graphs/contributors)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/prem-python-sdk-io/prem-python-sdk.svg)](https://github.com/premAI-io/prem-python-sdk/commits/master)
[![GitHub last commit](https://img.shields.io/github/last-commit/premAI-io/prem-python-sdk.svg)](https://github.com/premAI-io/prem-python-sdk/commits/master)
[![GitHub top language](https://img.shields.io/github/languages/top/premAI-io/prem-python-sdk.svg)](https://github.com/premAI-io/prem-python-sdk)
[![GitHub issues](https://img.shields.io/github/issues/premAI-io/prem-python-sdk.svg)](https://github.com/premAI-io/prem-python-sdk/issues)
Expand All @@ -26,6 +26,8 @@

## Installation

### From Source

1. Clone the Prem Python SDK repository:

```bash
Expand All @@ -39,6 +41,14 @@
source venv/bin/activate
pip install .
```
### From PyPI
You can also install the Prem Python SDK directly from PyPI.

```bash
python -m venv venv
source venv/bin/activate
pip install premai
```
## Usage
### Getting Started
To use the Prem Python SDK, you need to obtain an API key from the Prem platform. You can then create a `Prem` instance to make requests to the API.
Expand Down
9 changes: 4 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,15 @@ build-backend = "setuptools.build_meta"
[tool.setuptools_scm]

[project.urls]
documentation = "https://premai-io.github.io/prem-python-sdk/"
readme = "https://github.com/premAI-io/prem-python-sdk/blob/main/README.md"
repository = "https://github.com/premAI-io/prem-python-sdk"
changelog = "https://github.com/premAI-io/prem-python-sdk/releases"
Homepage = "https://github.com/premAI-io/prem-python-sdk"
Documentation = "https://premai-io.github.io/prem-python-sdk/"
Releases = "https://github.com/premAI-io/prem-python-sdk/tags"

[project]
name = "premai"
dynamic = ["version", "dependencies"]
maintainers = [{name = "Nicola Sosio", email = "[email protected]"}]
description = "The Prem Python SDK is a Python library for interacting with prem-saas"
description = "The Prem Python SDK is a Python library for interacting with [premai-saas](app.premai.io)"
readme = "README.md"
requires-python = ">=3.7"
license = {text = "Apache-2.0"}
Expand Down

0 comments on commit 802f929

Please sign in to comment.