Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
py-heptapod
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
heptapod
py-heptapod
Commits
543cebe2ae4b
There was a problem fetching the pipeline summary.
Commit
543cebe2ae4b
authored
5 years ago
by
Georges Racinet
Browse files
Options
Downloads
Patches
Plain Diff
Updated README, with development instructions
parent
25eedfef3e5e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!3
Full test coverage
Pipeline
#
Changes
1
Pipelines
2
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+41
-2
41 additions, 2 deletions
README.md
with
41 additions
and
2 deletions
README.md
+
41
−
2
View file @
543cebe2
...
...
@@ -3,4 +3,6 @@
[

](https://dev.heptapod.net/heptapod/py-heptapod/commits/branch/heptapod-0-7)
[

](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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment