Skip to content
Snippets Groups Projects
Commit 543cebe2ae4b authored by Georges Racinet's avatar Georges Racinet
Browse files

Updated README, with development instructions

parent 25eedfef3e5e
No related branches found
No related tags found
1 merge request!3Full test coverage
Pipeline #
......@@ -3,4 +3,6 @@
[![build status](https://dev.heptapod.net/heptapod/py-heptapod/badges/branch/heptapod-0-7/build.svg)](https://dev.heptapod.net/heptapod/py-heptapod/commits/branch/heptapod-0-7)
[![tests coverage](https://dev.heptapod.net/heptapod/py-heptapod/badges/branch/heptapod-0-7/coverage.svg)](https://dev.heptapod.net/heptapod/py-heptapod/commits/branch/heptapod-0-7)
The purpose of this package is to centralize all Python bits that are
specific to Heptapod and keep them in a high state of quality.
......@@ -6,6 +8,38 @@
## WSGI serving of repositories
This package is for now Python 2 only, meaning in particular that Python 3
utilities, such as the migration scripts are not hosted here yet.
We will migrate to Python 3 in one shot when Mercurial and hg-git do.
## Development guide
### Launching the tests
We have unit tests with `py.test`, they'd be typically run in a virtualenv.
```
virtualenv -p python2 venv
venv/bin/pip install -r install-requirements.txt -r tests-requirements.txt
venv/bin/pytest
```
Note: relying on virtualenv activation to run the tests simply as `pytest` has
been playing tricks with us, but the direct form above worked in all cases
### Workflow rules
We follow the Heptapod default workflow. Please make a topic, and submit a
Merge Requests.
Merge Request Pipelines have to pass, an coverage to stay at 100% for the MR to
be technically acceptable – we can help achieving these results, it's not
mandatory for submitting MRs and gather some feedback.
## Contents
### WSGI serving of repositories
Provided by `heptapod.wsgi` (not fully independent yet)
......@@ -8,11 +42,11 @@
Provided by `heptapod.wsgi` (not fully independent yet)
## Mercurial Hooks
### Mercurial Hooks
`heptapod.hooks.check_publish.check_publish`:
permission rules about public changesets in pushes.
`heptapod.hooks.git_sync.mirror`:
synchronisation to inner auxiliary Git repository for exposition to GitLab
`heptapod.hooks.dev_util`: useful hooks for debug and development
......@@ -13,6 +47,11 @@
`heptapod.hooks.check_publish.check_publish`:
permission rules about public changesets in pushes.
`heptapod.hooks.git_sync.mirror`:
synchronisation to inner auxiliary Git repository for exposition to GitLab
`heptapod.hooks.dev_util`: useful hooks for debug and development
### Mercurial extension
The `heptapod` extension will provide specific commands and generally everything
that should be done with full access to Mercurial internals.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment