Sibyl
  • Welcome to Sibyl
  • Getting Started
    • 💻Installation
    • 🚀Quickstart
  • User Guides
    • 🗃️Preparing the Database
      • Required Inputs
      • Configuring Applications
      • Populating the Database
        • sibyl.db API docs
    • 📡Running the REST-API Server
  • Developer Guides
    • ☺️Contributing to Sibyl
      • Types of Contributions
      • Making Contributions
      • Pull Request Guidelines
      • Code Style Guide
      • Unit Testing Guidelines
      • Release Workflow
  • Important Links
    • 📚API Documentation
    • 🔧Issues
    • ⚖️License
Powered by GitBook
On this page
  • From PyPI
  • From Source
  • Installing MongoDB
  1. Getting Started

Installation

From PyPI

To install Sibyl-API using pip, run the following command in your terminal:

pip install sibyl-api

This is the preferred method to install Sibyl-API, as it will always install the most recent and stable release.

From Source

The source code of Sibyl-API can be downloaded from the Github Repository.

You can clone the repository and install the latest development version from source by running poetry install on the dev branch:

git clone git://github.com/sibyl-dev/sibyl-api
cd sibyl-api
poetry install

The dev branch of the Sibyl-API repository contains the latest development version, which may include bugs or incomplete features. If you want to install the latest stable version, add git checkout stable after the cd command above.

Installing MongoDB

Sibyl-API requires MongoDB to access data. Before you can prepare your database and access API endpoints, you must install MongoDB by following the instructions here.

PreviousWelcome to SibylNextQuickstart

Last updated 1 year ago

💻