Skip to content

Update README.md #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TheRealEdDawson wants to merge 1 commit into from
Closed

Update README.md #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 11 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,7 @@ We support all versions that have a status of `bugfix` or `security` on [this](h
[(Back to top)](#table-of-contents)

## Installation
### **Installation via Pip**
Using Pip is the recommended way to install the Learnosity SDK for Python in production. The easiest way is to run this from your parent project folder:

pip install learnosity_sdk

Then, if you're following the tutorial on this page, also run:

pip install learnosity_sdk[quickstart]

### **Alternative method 1: download the zip file**
Download the latest version of the SDK as a self-contained ZIP file from the [GitHub Releases](https://github.com/Learnosity/learnosity-sdk-python/releases) page. The distribution ZIP file contains all the necessary dependencies.

Note: after installation, run this command in the SDK root folder:

pip install .

Then, if you're following the tutorial on this page, also run:

pip install .[quickstart]

### **Alternative 2: development install from a git clone**
### Method 1: development install from a git clone**
To install from the terminal, run the following command:

git clone [email protected]:Learnosity/learnosity-sdk-python.git
Expand All @@ -95,9 +75,17 @@ To set up up your local development environment, use the following:
Then, if you're following the tutorial on this page, also run:

pip install -e .[quickstart]

### Method 2: download the zip file**
Download the latest version of the SDK as a self-contained ZIP file from the [GitHub Releases](https://github.com/Learnosity/learnosity-sdk-python/releases) page. The distribution ZIP file contains all the necessary dependencies.

Note: after installation, run this command in the SDK root folder:

Note that these manual installation methods are for development and testing only.
For production use, you should install the SDK using the Pip package manager for Python, as described above.
pip install .

Then, if you're following the tutorial on this page, also run:

pip install .[quickstart]

[(Back to top)](#table-of-contents)

Expand Down