Skip to content

Commit

Permalink
Update buildout structure
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleybl committed Apr 20, 2022
1 parent eaa9814 commit cfa92e5
Show file tree
Hide file tree
Showing 124 changed files with 939 additions and 282 deletions.
6 changes: 6 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[report]
include =
src/collective/*
omit =
*/test*
*/upgrades/*
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[*]
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8

[{*.py,*.cfg}]
indent_size = 4

[{*.html,*.dtml,*.pt,*.zpt,*.xml,*.zcml,*.js}]
indent_size = 2

[Makefile]
indent_style = tab
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CHANGES.rst merge=union
64 changes: 36 additions & 28 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,31 +1,39 @@
*.mo
.coverage
.coverage.*
*.egg-info
*.egg
*.EGG
*.EGG-INFO
var
bin
build
develop-eggs
downloads
eggs
fake-eggs
parts
dist
.installed.cfg
.mr.developer.cfg
.hg
.bzr
.svn
*.pyc
*.pyo
*.tmp*
src
.project
.pydevproject
testrelease
.eggs/
*.log
*.mo
*.py?
*.swp
.*project
# dirs
/.settings/
bin/
buildout-cache/
develop-eggs/
eggs/
htmlcov/
include/
lib/

.DS_Store
local/
node_modules/
parts/
dist/*
test.plone_addon/
var/
# files
.installed.cfg
.mr.developer.cfg
coverage.xml
lib64
local.cfg
log.html
output.xml
pip-selfcheck.json
pyvenv.cfg
report.html
.vscode/
.tox/
reports/
venv/
# excludes
5 changes: 5 additions & 0 deletions CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Contributors
============

- JeanMichel FRANCOIS aka toutpt, toutpt@gmail.com
- Wesley Barroso Lopes, wesleybl@gmail.com
76 changes: 76 additions & 0 deletions DEVELOP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
Using the development buildout
==============================

plonecli
--------

The convenient way, use plonecli build ;)::

$ plonecli build

or with --clear if you want to clean your existing venv::

$ plonecli build --clear

Start your instance::

$ plonecli serve


Without plonecli
----------------

Create a virtualenv in the package::

$ python3 -m venv venv

or with --clear if you want to clean your existing venv::

$ python3 -m venv venv --clear

Install requirements with pip::

$ ./venv/bin/pip install -r requirements.txt

bootstrap your buildout::

$ ./bin/buildout bootstrap

Run buildout::

$ ./bin/buildout

Start Plone in foreground::

$ ./bin/instance fg


Running tests
-------------

$ tox

list all tox environments::

$ tox -l
py27-Plone43
py27-Plone51
py27-Plone52
py37-Plone52
build_instance
code-analysis
lint-py27
lint-py37
coverage-report

run a specific tox env::

$ tox -e py37-Plone52


CI Github-Actions / codecov
---------------------------

The first time you push the repo to github, you might get an error from codecov.
Either you activate the package here: `https://app.codecov.io/gh/collective/+ <https://app.codecov.io/gh/collective/+>`_
Or you just wait a bit, codecov will activate your package automatically.
Loading

0 comments on commit cfa92e5

Please sign in to comment.