almet/copanier
1
0
Fork 0
mirror of https://github.com/almet/copanier.git synced 2025-04-28 19:42:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Enhance the installation instructions

Browse source
This commit is contained in:
Alexis Métaireau 2020-12-05 13:46:14 +01:00
parent 458968a133
commit d19bab7260
1 changed files with 33 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -54,32 +54,45 @@ In copanier, we only focus on groups of consumers. We want to keep things as str
## Install copanier locally ## Install copanier locally
### Get the system dependencies
You might need to install some system dependencies. On
[Debian-based](https://www.debian.org) systems, you can install the
dependencies with this command:
```bash
sudo apt install python3-dev python3-venv python3-pip libcairo-dev libpango1.0-dev
```
The project relies on Python 3.7+, so if you don't have it yet, here's your The project relies on Python 3.7+, so if you don't have it yet, here's your
chance! chance!
One way to install it, is to use [pyenv](https://github.com/pyenv/pyenv): One way to install it is to use [pyenv](https://github.com/pyenv/pyenv):
```bash ```bash
$ pyenv install 3.7.1 pyenv install 3.7.1
$ pyenv global 3.7.1 pyenv global 3.7.1
``` ```
And then create a virtualenv so everything is installed separately from the ### Install copanier
We recommend to use virtualenv so everything is installed separately from the
rest of the system: rest of the system:
```bash ```bash
$ # Get the source code locally # Get the source code locally
$ git clone https://github.com/spiral-project/copanier.git git clone https://github.com/spiral-project/copanier.git
$ cd copanier cd copanier
$ # Create the virtualenv # Create the virtualenv
$ python -m venv venv python -m venv venv
# On some systems, you might need to specify "python3.7 -m venv venv"
$ # Activate it! # Activate it!
$ source venv/bin/activate source venv/bin/activate
$ # install everything! # install everything!
$ pip install -e . pip install -e .
``` ```
## Run local server ## Run local server
@ -89,13 +102,13 @@ Once everything is installed, you can use the `copanier` command to run the serv
Make sure venv is active, then: Make sure venv is active, then:
```bash ```bash
$ copanier serve copanier serve
``` ```
Optionally autoreload the server when you change a python file (needs `hupper`): Optionally autoreload the server when you change a python file (needs `hupper`):
```bash ```bash
$ copanier serve --reload copanier serve --reload
``` ```
Then browse to [http://localhost:2244](http://localhost:2244) Then browse to [http://localhost:2244](http://localhost:2244)
@ -106,16 +119,16 @@ If you want to contribute, don't hesitate! In this case, it might be helpful to
install a few other dependencies. install a few other dependencies.
```bash ```bash
$ pip instal -e .[test] pip instal -e .[test]
``` ```
Then, to run the tests: Then, to run the tests:
```bash ```bash
$ # install the required dependencies for dev # install the required dependencies for dev
$ pip install -r requirements-dev.txt pip install -r requirements-dev.txt
$ # run the tests # run the tests
$ py.test tests py.test tests
``` ```
## Configuration ## Configuration