Skip to content

Commit cfa92e5

Browse files
committed
Update buildout structure
1 parent eaa9814 commit cfa92e5

File tree

124 files changed

+939
-282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+939
-282
lines changed

.coveragerc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[report]
2+
include =
3+
src/collective/*
4+
omit =
5+
*/test*
6+
*/upgrades/*

.editorconfig

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[*]
2+
indent_style = space
3+
end_of_line = lf
4+
insert_final_newline = true
5+
trim_trailing_whitespace = true
6+
charset = utf-8
7+
8+
[{*.py,*.cfg}]
9+
indent_size = 4
10+
11+
[{*.html,*.dtml,*.pt,*.zpt,*.xml,*.zcml,*.js}]
12+
indent_size = 2
13+
14+
[Makefile]
15+
indent_style = tab

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHANGES.rst merge=union

.gitignore

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,39 @@
1-
*.mo
1+
.coverage
2+
.coverage.*
23
*.egg-info
3-
*.egg
4-
*.EGG
5-
*.EGG-INFO
6-
var
7-
bin
8-
build
9-
develop-eggs
10-
downloads
11-
eggs
12-
fake-eggs
13-
parts
14-
dist
15-
.installed.cfg
16-
.mr.developer.cfg
17-
.hg
18-
.bzr
19-
.svn
20-
*.pyc
21-
*.pyo
22-
*.tmp*
23-
src
24-
.project
25-
.pydevproject
26-
testrelease
27-
.eggs/
4+
*.log
5+
*.mo
6+
*.py?
7+
*.swp
8+
.*project
9+
# dirs
10+
/.settings/
11+
bin/
12+
buildout-cache/
13+
develop-eggs/
14+
eggs/
15+
htmlcov/
2816
include/
2917
lib/
30-
31-
.DS_Store
18+
local/
19+
node_modules/
20+
parts/
21+
dist/*
22+
test.plone_addon/
23+
var/
24+
# files
25+
.installed.cfg
26+
.mr.developer.cfg
27+
coverage.xml
28+
lib64
29+
local.cfg
30+
log.html
31+
output.xml
32+
pip-selfcheck.json
33+
pyvenv.cfg
34+
report.html
35+
.vscode/
36+
.tox/
37+
reports/
38+
venv/
39+
# excludes

CONTRIBUTORS.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Contributors
2+
============
3+
4+
- JeanMichel FRANCOIS aka toutpt, [email protected]
5+
- Wesley Barroso Lopes, [email protected]

DEVELOP.rst

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
Using the development buildout
2+
==============================
3+
4+
plonecli
5+
--------
6+
7+
The convenient way, use plonecli build ;)::
8+
9+
$ plonecli build
10+
11+
or with --clear if you want to clean your existing venv::
12+
13+
$ plonecli build --clear
14+
15+
Start your instance::
16+
17+
$ plonecli serve
18+
19+
20+
Without plonecli
21+
----------------
22+
23+
Create a virtualenv in the package::
24+
25+
$ python3 -m venv venv
26+
27+
or with --clear if you want to clean your existing venv::
28+
29+
$ python3 -m venv venv --clear
30+
31+
Install requirements with pip::
32+
33+
$ ./venv/bin/pip install -r requirements.txt
34+
35+
bootstrap your buildout::
36+
37+
$ ./bin/buildout bootstrap
38+
39+
Run buildout::
40+
41+
$ ./bin/buildout
42+
43+
Start Plone in foreground::
44+
45+
$ ./bin/instance fg
46+
47+
48+
Running tests
49+
-------------
50+
51+
$ tox
52+
53+
list all tox environments::
54+
55+
$ tox -l
56+
py27-Plone43
57+
py27-Plone51
58+
py27-Plone52
59+
py37-Plone52
60+
build_instance
61+
code-analysis
62+
lint-py27
63+
lint-py37
64+
coverage-report
65+
66+
run a specific tox env::
67+
68+
$ tox -e py37-Plone52
69+
70+
71+
CI Github-Actions / codecov
72+
---------------------------
73+
74+
The first time you push the repo to github, you might get an error from codecov.
75+
Either you activate the package here: `https://app.codecov.io/gh/collective/+ <https://app.codecov.io/gh/collective/+>`_
76+
Or you just wait a bit, codecov will activate your package automatically.

0 commit comments

Comments
 (0)