Guénaël Muller fe6d7a424e add some documentations for tracimcli tool 6 年之前
doc add some documentations for tracimcli tool 6 年之前
tracim rename command_line test for better test 6 年之前
.coveragerc configure coverage 6 年之前
.gitignore some typing and pep8 6 年之前
.travis.yml configure coverage 6 年之前
CHANGES.txt Update CHANGES.txt 6 年之前
MANIFEST.in Begin Pyramid Alchemy Project with cookiecutter 6 年之前
README.md add some documentations for tracimcli tool 6 年之前
development.ini.sample doc for alembic + same config file as pyramid 6 年之前
production.ini Begin Pyramid Alchemy Project with cookiecutter 6 年之前
pytest.ini fix pytest conf 6 年之前
setup.py add command for initializedb and users 6 年之前

README.md

Build Status Coverage Status Scrutinizer Code Quality

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

TODO

Setup Python Virtualenv

Go to tracim subdirectory:

cd tracim

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]"

Configure Tracim_backend

Create configuration files for a development environment:

cp development.ini.base development.ini

Initialize the database using tracimcli tool

tracimcli db init

Run Tracim_backend

Run your project:

pserve development.ini

Run Tests and others checks

Run your project's tests:

pytest

Run mypy checks:

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

Run pep8 checks:

pep8 tracim

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