Guénaël Muller 078bb35779 rq need redis-server		6 gadus atpakaļ
doc	add command to delete database, usefull for testing	6 gadus atpakaļ
tracim	add test for async rq mode	6 gadus atpakaļ
.coveragerc	configure coverage	6 gadus atpakaļ
.gitignore	fix README + Webdav default conf	6 gadus atpakaļ
.travis.yml	rq need redis-server	6 gadus atpakaļ
CHANGES.txt	Update CHANGES.txt	6 gadus atpakaļ
MANIFEST.in	Begin Pyramid Alchemy Project with cookiecutter	6 gadus atpakaļ
README.md	rq need redis-server	6 gadus atpakaļ
development.ini.sample	correct tracim egg in conf	6 gadus atpakaļ
production.ini	Begin Pyramid Alchemy Project with cookiecutter	6 gadus atpakaļ
pytest.ini	fix pytest conf	6 gadus atpakaļ
setup.py	better test for email	6 gadus atpakaļ
tests_configs.ini	add test for async rq mode	6 gadus atpakaļ
wsgidav.conf.sample	fix README + Webdav default conf	6 gadus atpakaļ

tracim_backend

This code is Work in progress. Not usable at all for production.

Backend source code of tracim v2, using Pyramid Framework.

Installation

Distribution dependencies

on Debian Stretch (9) with sudo:

sudo apt update
sudo apt install git
sudo apt install python3 python3-venv python3-dev python3-pip
sudo apt install redis-server

Get the source

get source from github:

git clone https://github.com/tracim/tracim_backend.git

go to tracim_backend directory:

cd tracim_backend

Setup Python Virtualenv

Create a Python virtual environment:

python3 -m venv env

Activate it in your terminal session (all tracim command execution must be executed under this virtual environment):

source env/bin/activate

Upgrade packaging tools:

pip install --upgrade pip setuptools

Install the project in editable mode with its testing requirements :

pip install -e ".[testing]"

If you want to use postgresql, mysql or other databases than the default one: sqlite, you need to install python driver for those databases that are supported by sqlalchemy.

For postgreSQL and mySQL, those are shortcuts to install Tracim with test and specific driver.

For PostgreSQL:

pip install -e ".[testing,postgresql]"

For mySQL:

pip install -e ".[testing,mysql]"

Configure Tracim_backend

Create configuration file for a development environment:

cp development.ini.sample development.ini

Initialize the database using tracimcli tool

tracimcli db init

Run Tracim_backend

Run your project:

pserve development.ini

Configure and Run Webdav Server (Unstable)

create wsgidav configuration file :

cp wsgidav.conf.sample wsgidav.conf

run wsgidav server:

tracimcli webdav start

Run Tests

Before running some functional test related to email, you need a local working MailHog see here : https://github.com/mailhog/MailHog

You can run it this way with docker :

docker pull mailhog/mailhog
docker run -d -p 1025:1025 -p 8025:8025 mailhog/mailhog

Run your project's tests:

pytest

Lints and others checks

Run mypy checks:

mypy --ignore-missing-imports --disallow-untyped-defs tracim

Run pep8 checks:

pep8 tracim

Tracim API

Tracim_backend give access to a REST API in /api/v2. This API is auto-documented with Hapic. The specification is accessible when you run Tracim, go to /api/v2/doc .

For example, with default config:

# run tracim
pserve development.ini
# launch your favorite web-browser
firefox http://localhost:6543/api/v2/doc/

CI

Code quality: https://scrutinizer-ci.com/g/tracim/tracim_backend/
Test validation: https://travis-ci.org/tracim/tracim_backend
Code coverage: https://coveralls.io/github/tracim/tracim_backend

README.md