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

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