Skip to content

Commit

Permalink
Rename repo, modify README and fix CI triggers
Browse files Browse the repository at this point in the history
  • Loading branch information
hammady committed Sep 15, 2023
1 parent e54df45 commit a606287
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/publish-pypi.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
name: Publish to PyPI
on:
push:
branches:
- master
tags:
- v*
jobs:
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Rayyan Python SDK

A Python SDK for Rayyan [HTTP APIs](https://github.com/rayyansys/rayyan-api-docs).
A Python SDK for [Rayyan](https://www.rayyan.ai/), the popular systematic reviews platform.
It is a wrapper around the [HTTP APIs](https://github.com/rayyansys/rayyan-api-docs) of Rayyan.
## Installation

To install the latest stable release of Rayyan Python SDK, execute the following command:
Expand All @@ -18,7 +19,8 @@ pip install -i https://test.pypi.org/simple/ rayyan-sdk
## Usage

To use the SDK, you need to have a credentials file in JSON format like the one below.
You can retrieve such file by signing in to your Rayyan account and going to My Account page.
You can retrieve such file by signing in to your Rayyan account
(create a free account if you don't have one) and visiting My Account page.

```json
// creds.json
Expand All @@ -45,22 +47,24 @@ user = rayyan.user.get_info()

## Documentation

The full documentation for Rayyan Python SDK is available on
[GitHub](https://github.com/rayyansys/rayyan-api-py/tree/master/docs).
You can also find a Juptyer notebook with examples here: `rayyan-api.ipynb`.
The full documentation for Rayyan Python SDK is available in the
[docs](https://github.com/rayyansys/rayyan-python-sdk/tree/master/docs) folder on GitHub.
You can also find a Juptyer notebook with examples in
[rayyan-api.ipynb](https://github.com/rayyansys/rayyan-python-sdk/blob/master/rayyan-api.ipynb).

## Development

To build Rayyan Python SDK from source, execute the following command in a terminal:

```shell
git clone https://github.com/rayyansys/rayyan-api-py
cd rayyan-api-py
git clone https://github.com/rayyansys/rayyan-python-sdk
cd rayyan-python-sdk
python setup.py develop
```

## Support

If you have any questions or problems with the SDK,
please create an issue on [GitHub](https://github.com/rayyansys/rayyan-api-py).
please check existing issues on [GitHub](https://github.com/rayyansys/rayyan-python-sdk/issues),
or open a new issue if needed.
For questions about Rayyan itself, please use the Rayyan [Help Center](https://help.rayyan.ai/).
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[metadata]
name = rayyan-sdk
version = 1.0rc6
version = 1.0rc7
description = A Python SDK for Rayyan APIs
long_description = file: README.md
long_description_content_type = text/markdown
url = https://www.rayyan.ai/
url = https://github.com/rayyansys/rayyan-python-sdk
author = Rayyan Systems, Inc.
author_email = [email protected]
license = MIT
Expand Down

0 comments on commit a606287

Please sign in to comment.