Metadata-Version: 2.1
Name: sib-manager
Version: 0.4.1
Summary: StartinBlox Manager
Home-page: https://git.happy-dev.fr/startinblox/sib-installer
Author: Plup
Author-email: plup@plup.io
License: MIT
Description: # Startin'Blox Manager
        
        ## Requirements
        
        You will need both Python3 and Pip3 installed. You can follow [this article](https://realpython.com/installing-python/) if you don't konw where to start.
        
        Before diving in Startin' Blox manager, just make sure you got the last version of `pip` by upgrading it:
        ```
        sudo pip3 install --upgrade pip
        ```
        
        Then install the `sib` command line:
        ```
        $ pip3 install --user -U sib-manager
        ```
        
        Note:
        
         * This install the `sib` program in the user context. `sib` doesn't need system priveleges
         * In some distribution the system can't find the user programs. In that case you have to add it manually, for example, by adding `export PATH=$HOME/.local/bin:$PATH` in your `~/.bashrc`.
        
        ## Get started with a new project
        
        `sib` supports installation inside `venv`
        
        Create a new project:
        ```
        $ sib startproject myproject
        $ cd myproject
        ```
        
        Note:
        
         * The project name must be a valid python package name (no dashes).
        
        Configure the modules you want to use in `packages.yml`:
        ```
        ldppackages:
          djangoldp_project: djangoldp_project
          oidc_provider:     django-oidc-provider
        ```
        
        Run the installation:
        ```
        $ sib install myproject
        ```
        
        And launch it locally !
        ```
        $ python3 manage.py runserver
        ```
        
        The administration interface is available at `http://localhost:8000/admin/` with default `admin` user and password.
        
        ## Usage
        
        ```
        $ sib --help
        Usage: sib [OPTIONS] COMMAND [ARGS]...
        
          Startin'Blox installer
        ```
        
        `sib` manager can be used to deploy local development and production instances. Whereas a development instance relies on testing components as a `sqlite` database and comes with default configuration, a production instance needs more parameters to configure the `postgresql` database.
        
        ## Contribute
        
        Get the last unreleased version of the project:
        ```
        $ pip3 install --user -U git+https://git.happy-dev.fr/startinblox/devops/sib
        ```
        
        ## Test strategy
        
        To test:
        
         * create superuser twice
         * add a package after install and update
         * install without packages
        
        Test production setup with postgres:
        ```
        # docker network create sib
        # docker run --rm --network sib --name db -e POSTGRES_PASSWORD=test -d postgres
        # docker run --rm --network sib -p 127.0.0.1:80:8000 -v $PWD:/code -it python:3.6 bash
        # pip install -e .[dev]
        # sib startproject --production --db-host db --db-name postgres --db-user postgres --db-pass test -m djangoldp_project -m oidc_provider:django-oidc-provider myproject /tmp/test-sib-docker
        # sib initproject --production --admin-name admin --admin-email 'something' --admin-pass admin myproject /tmp/test-sib-docker
        # cd /tmp/test-sib-docker/
        # python manage.py runserver 0.0.0.0:8000
        ```
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
