tracim_v2

Guénaël Muller acd77f215e merge with master		7 gadus atpakaļ
tracim	merge with master	7 gadus atpakaļ
.coveragerc	configure coverage	7 gadus atpakaļ
.gitignore	some typing and pep8	7 gadus atpakaļ
.travis.yml	configure coverage	7 gadus atpakaļ
CHANGES.txt	Begin Pyramid Alchemy Project with cookiecutter	7 gadus atpakaļ
MANIFEST.in	Begin Pyramid Alchemy Project with cookiecutter	7 gadus atpakaļ
README.txt	Merge branch 'master' into coding/typing_and_pep8	7 gadus atpakaļ
alembic.ini	drop example model, add alembic tracimv1 history and use same database scheme as tracimv1	7 gadus atpakaļ
development.ini.sample	add config dev sample	7 gadus atpakaļ
production.ini	Begin Pyramid Alchemy Project with cookiecutter	7 gadus atpakaļ
pytest.ini	fix pytest conf	7 gadus atpakaļ
setup.py	merge with master	7 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.

Getting Started
---------------

- Change directory into your newly created project.

    cd tracim

- Create a Python virtual environment.

    python3 -m venv env

- Upgrade packaging tools.

    env/bin/pip install --upgrade pip setuptools

- Install the project in editable mode with its testing requirements.

    env/bin/pip install -e ".[testing]"

- Configure the database.

    env/bin/initialize_tracim_db development.ini

- Run your project's tests.

    env/bin/pytest

- Run your project.

    env/bin/pserve development.ini

- 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

README.txt