Skip to content

Commit b90b8a9

Browse files
authored
Merge pull request #2 from smoia/int/setup
Finish setup and attempt built
2 parents 777490d + ab2a318 commit b90b8a9

Some content is hidden

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

59 files changed

+1032
-441
lines changed

.autorc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
["pr-body-labels", { "disabledLabels": ["release", "Release", "Released", "Prereleased", "Skip release"] }]
88
],
99
"owner": "physiopy",
10-
"repo": "<reponame>",
10+
"repo": "physiopy-community-guidelines",
1111
"name": "Stefano Moia",
1212
"email": "[email protected]",
1313
"labels": [

.circleci/config.yml

Lines changed: 3 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -10,83 +10,15 @@ orbs:
1010
# so you dont have to copy and paste it everywhere.
1111
# See the orb documentation here: https://circleci.com/developer/orbs/orb/circleci/python
1212
python: circleci/[email protected]
13-
codecov: codecov/[email protected]
1413

1514
# Define a job to be invoked later in a workflow.
1615
# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
1716
jobs:
18-
test37: # This is the name of the job, feel free to change it to better match what you're trying to do!
19-
# These next lines defines a Docker executors: https://circleci.com/docs/2.0/executor-types/
20-
# You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
21-
# A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
22-
# The executor is the environment in which the steps below will be executed - below will use a python 3.6.14 container
23-
# Change the version below to your required version of python
24-
docker:
25-
- image: cimg/python:3.7
26-
working_directory: /tmp/src/<reponame>
27-
resource_class: medium
28-
# Checkout the code as the first step. This is a dedicated CircleCI step.
29-
# The python orb's install-packages step will install the dependencies from a Pipfile via Pipenv by default.
30-
# Here we're making sure we use just use the system-wide pip. By default it uses the project root's requirements.txt.
31-
# Then run your tests!
32-
# CircleCI will report the results back to your VCS provider.
33-
steps:
34-
- checkout
35-
# Install Pillow first to avoid jpsg and zlib issues
36-
- python/install-packages:
37-
path-args: .[test]
38-
pypi-cache: false
39-
venv-cache: false
40-
pkg-manager: pip-dist
41-
# app-dir: ~/project/package-directory/ # If you're requirements.txt isn't in the root directory.
42-
# pip-dependency-file: test-requirements.txt # if you have a different name for your requirements file, maybe one that combines your runtime and test requirements.
43-
- run:
44-
name: Run tests
45-
# This assumes pytest is installed via the install-package step above
46-
command: |
47-
pytest --cov=./<reponame>
48-
mkdir /tmp/src/coverage
49-
mv ./.coverage /tmp/src/coverage/.coverage.py37
50-
- store_artifacts:
51-
path: /tmp/src/coverage
52-
# Persist the specified paths (workspace/echo-output) into the workspace for use in downstream job.
53-
- persist_to_workspace:
54-
# Must be an absolute path, or relative path from working_directory. This is a directory on the container which is
55-
# taken to be the root directory of the workspace.
56-
root: /tmp
57-
# Must be relative path from root
58-
paths:
59-
- src/coverage/.coverage.py37
60-
61-
test310:
62-
docker:
63-
- image: cimg/python:3.10
64-
working_directory: /tmp/src/<reponame>
65-
resource_class: medium
66-
steps:
67-
- checkout
68-
- python/install-packages:
69-
path-args: .[test]
70-
pypi-cache: false
71-
venv-cache: false
72-
pkg-manager: pip-dist
73-
- run:
74-
name: Run tests
75-
command: |
76-
pytest --cov=./<reponame>
77-
mkdir /tmp/src/coverage
78-
mv ./.coverage /tmp/src/coverage/.coverage.py310
79-
- store_artifacts:
80-
path: /tmp/src/coverage
81-
- persist_to_workspace:
82-
root: /tmp
83-
paths:
84-
- src/coverage/.coverage.py310
8517

8618
style_check:
8719
docker:
8820
- image: cimg/python:3.7
89-
working_directory: /tmp/src/<reponame>
21+
working_directory: /tmp/src/physiopy-community-guidelines
9022
resource_class: small
9123
steps:
9224
- checkout
@@ -99,32 +31,8 @@ jobs:
9931
name: Check style
10032
command: |
10133
isort --check .
102-
black --check <reponame>
103-
flake8 ./<reponame>
104-
105-
merge_coverage:
106-
working_directory: /tmp/src/<reponame>
107-
docker:
108-
- image: cimg/python:3.10
109-
resource_class: small
110-
steps:
111-
- attach_workspace:
112-
at: /tmp
113-
- checkout
114-
- python/install-packages:
115-
args: coverage
116-
pkg-manager: pip
117-
- run:
118-
name: Merge coverage files
119-
command: |
120-
sudo apt update && sudo apt install curl
121-
cd /tmp/src/coverage/
122-
coverage combine
123-
coverage xml
124-
- store_artifacts:
125-
path: /tmp/src/coverage
126-
- codecov/upload:
127-
file: /tmp/src/coverage/coverage.xml
34+
black --check physiopy-community-guidelines
35+
flake8 ./physiopy-community-guidelines
12836
12937
# Invoke jobs via workflows
13038
# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
@@ -133,13 +41,3 @@ workflows:
13341
# Inside the workflow, you define the jobs you want to run.
13442
jobs:
13543
- style_check
136-
- test37:
137-
requires:
138-
- style_check
139-
- test310:
140-
requires:
141-
- style_check
142-
- merge_coverage:
143-
requires:
144-
- test37
145-
- test310

.coveragerc

Lines changed: 0 additions & 19 deletions
This file was deleted.

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<reponame>/_version.py export-subst
1+
physiopy-community-guidelines/_version.py export-subst
22

33
*.py eol=lf
44
*.rst eol=lf

.pre-commit-config.yaml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,6 @@ repos:
1010
- id: check-added-large-files
1111
- id: check-case-conflict
1212
- id: check-merge-conflict
13-
- repo: https://github.com/psf/black
14-
rev: 22.10.0
15-
hooks:
16-
- id: black
17-
- repo: https://github.com/pycqa/isort
18-
rev: 5.10.1
19-
hooks:
20-
- id: isort
21-
- repo: https://github.com/pycqa/flake8
22-
rev: 6.0.0
23-
hooks:
24-
- id: flake8
2513
- repo: https://github.com/pycqa/pydocstyle
2614
rev: 6.1.1
2715
hooks:

.readthedocs.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,19 @@ version: 2
88
build:
99
os: "ubuntu-20.04"
1010
tools:
11-
python: "3.7"
11+
python: "3.10"
1212

1313
# Build documentation in the docs/ directory with Sphinx
1414
sphinx:
15-
configuration: docs/conf.py
15+
configuration: docs/source/conf.py
16+
17+
formats:
18+
- pdf
19+
- epub
1620

1721
python:
1822
install:
1923
- method: pip
2024
path: .
2125
extra_requirements:
22-
- doc
23-
system_packages: true
26+
- style

.zenodo.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"license":"<License>",
3-
"title":"<Title>",
2+
"license":"CC-BY-SA-4.0",
3+
"title":"Physiopy Community Guidelines",
44
"upload_type":"software",
55
"creators":[
66
{

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
include README.* LICENSE setup* MANIFEST.in requirements.txt
22

33
include versioneer.py
4-
include <reponame>/_version.py
4+
include docs/_version.py

README.md

Lines changed: 17 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -2,90 +2,33 @@
22
<a name="readme"></a>
33
<img alt="repository" src="https://raw.githubusercontent.com/physiopy/phys2bids/master/docs/_static/physiopy_logo_small.png" height="150">
44

5-
This is a template for physiopy's repositories (and other repositories based on the same settings).
6-
7-
Remember to change the licence as soon as you adopt the template.
8-
9-
Available Configurations
10-
------------------------
11-
This repository is meant to be a template for python3 projects.
12-
- CircleCI medium docker running Linux (python 3.7, 3.10, style checks, and coverage)
13-
- Auto release based on Github versioning with Physiopy's labels.
14-
- `.gitattributes` for python
15-
- `.gitignore` for python and containers
16-
- Pre-commit (black, isort, flake8, pydocstyle, and RST documentation)
17-
- Read the Docs (based on sphinx)
18-
- Zenodo
19-
- Codecov (for master branch, 90%+)
20-
- Python setup with `extra_require` options
21-
- Versioneer
22-
- Issue templates (bugs, feature requests, generic)
23-
- PR template
24-
- Workflows (Auto release and PyPI upload)
25-
26-
Usage
27-
-----
28-
1. Find and replace the items between `<>`, for instance `<reponame>`
29-
2. Change licence
30-
3. Set up your default pushes to `origin` (`git config remote.pushDefault origin`)
31-
4. Finish setting up everything.
32-
33-
More explanation coming soon.
34-
35-
<reponame>
36-
==========
37-
38-
[![Latest version](https://img.shields.io/github/v/release/physiopy/<reponame>?style=flat&logo=github&sort=semver)](https://github.com/physiopy/<reponame>/releases)
39-
[![Release date](https://img.shields.io/github/release-date/physiopy/<reponame>?style=flat&logo=github)](https://github.com/physiopy/<reponame>/releases)
40-
[![Auto Release](https://img.shields.io/badge/release-auto.svg?style=flat&colorA=888888&colorB=9B065A&label=auto&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto)
5+
This repository contains the source files for our community guidelines.
416

42-
[![See the documentation at: https://<reponame>.readthedocs.io](https://img.shields.io/badge/docs-read%20latest-informational?style=flat&logo=readthedocs)](https://<reponame>.readthedocs.io/en/latest/?badge=latest)
43-
<!-- [![Latest DOI](https://zenodo.org/badge/<doi>.svg)](https://zenodo.org/badge/latestdoi/<doi>) -->
44-
<!-- [![Licensed Apache 2.0](https://img.shields.io/github/license/physiopy/<reponame>?style=flat&logo=apache)](https://github.com/physiopy/<reponame>/blob/master/LICENSE) -->
7+
Find them at https://physiopy-community-guidelines.readthedocs.io/en/latest/
8+
9+
10+
physiopy-community-guidelines
11+
=============================
4512

46-
[![Codecov](https://img.shields.io/codecov/c/gh/physiopy/<reponame>?style=flat&label=codecov&logo=codecov)](https://codecov.io/gh/physiopy/<reponame>)
47-
[![Build Status](https://img.shields.io/circleci/build/github/physiopy/<reponame>?style=flat&label=circleci&logo=circleci)](https://circleci.com/gh/physiopy/<reponame>)
48-
[![Documentation Status](https://img.shields.io/readthedocs/<reponame>?style=flat&label=readthedocs&logo=readthedocs)](https://<reponame>.readthedocs.io/en/latest/?badge=latest)
13+
[![Latest version](https://img.shields.io/github/v/release/physiopy/physiopy-community-guidelines?style=flat&logo=github&sort=semver)](https://github.com/physiopy/physiopy-community-guidelines/releases)
14+
[![Release date](https://img.shields.io/github/release-date/physiopy/physiopy-community-guidelines?style=flat&logo=github)](https://github.com/physiopy/physiopy-community-guidelines/releases)
15+
[![Auto Release](https://img.shields.io/badge/release-auto.svg?style=flat&colorA=888888&colorB=9B065A&label=auto&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAACzElEQVR4AYXBW2iVBQAA4O+/nLlLO9NM7JSXasko2ASZMaKyhRKEDH2ohxHVWy6EiIiiLOgiZG9CtdgG0VNQoJEXRogVgZYylI1skiKVITPTTtnv3M7+v8UvnG3M+r7APLIRxStn69qzqeBBrMYyBDiL4SD0VeFmRwtrkrI5IjP0F7rjzrSjvbTqwubiLZffySrhRrSghBJa8EBYY0NyLJt8bDBOtzbEY72TldQ1kRm6otana8JK3/kzN/3V/NBPU6HsNnNlZAz/ukOalb0RBJKeQnykd7LiX5Fp/YXuQlfUuhXbg8Di5GL9jbXFq/tLa86PpxPhAPrwCYaiorS8L/uuPJh1hZFbcR8mewrx0d7JShr3F7pNW4vX0GRakKWVk7taDq7uPvFWw8YkMcPVb+vfvfRZ1i7zqFwjtmFouL72y6C/0L0Ie3GvaQXRyYVB3YZNE32/+A/D9bVLcRB3yw3hkRCdaDUtFl6Ykr20aaLvKoqIXUdbMj6GFzAmdxfWx9iIRrkDr1f27cFONGMUo/gRI/jNbIMYxJOoR1cY0OGaVPb5z9mlKbyJP/EsdmIXvsFmM7Ql42nEblX3xI1BbYbTkXCqRnxUbgzPo4T7sQBNeBG7zbAiDI8nWfZDhQWYCG4PFr+HMBQ6l5VPJybeRyJXwsdYJ/cRnlJV0yB4ZlUYtFQIkMZnst8fRrPcKezHCblz2IInMIkPzbbyb9mW42nWInc2xmE0y61AJ06oGsXL5rcOK1UdCbEXiVwNXsEy/6+EbaiVG8eeEAfxvaoSBnCH61uOD7BS1Ul8ESHBKWxCrdyd6EYNKihgEVrwOAbQruoytuBYIFfAc3gVN6iawhjKyNCEpYhVJXgbOzARyaU4hCtYizq5EI1YgiUoIlT1B7ZjByqmRWYbwtdYjoWoN7+LOIQefIqKawLzK6ID69GGpQgwhhEcwGGUzfEPAiPqsCXadFsAAAAASUVORK5CYII=)](https://github.com/intuit/auto)
4916

50-
[![Latest version](https://img.shields.io/pypi/v/<reponame>?style=flat&logo=pypi&logoColor=white)](https://pypi.org/project/<reponame>/)
51-
[![Supports python version](https://img.shields.io/pypi/pyversions/<reponame>?style=flat&logo=python&logoColor=white)](https://pypi.org/project/<reponame>/)
17+
[![See the documentation at: https://physiopy-community-guidelines.readthedocs.io](https://img.shields.io/badge/docs-read%20latest-informational?style=flat&logo=readthedocs)](https://physiopy-community-guidelines.readthedocs.io/en/latest/?badge=latest)
18+
<!-- [![Latest DOI](https://zenodo.org/badge/<doi>.svg)](https://zenodo.org/badge/latestdoi/<doi>) -->
19+
<!-- [![Licensed Apache 2.0](https://img.shields.io/github/license/physiopy/physiopy-community-guidelines?style=flat&logo=apache)](https://github.com/physiopy/physiopy-community-guidelines/blob/master/LICENSE) -->
5220

21+
[![Documentation Status](https://img.shields.io/readthedocs/physiopy-community-guidelines?style=flat&label=readthedocs&logo=readthedocs)](https://physiopy-community-guidelines.readthedocs.io/en/latest/?badge=latest)
22+
[![Latest version](https://img.shields.io/pypi/v/physiopy-community-guidelines?style=flat&logo=pypi&logoColor=white)](https://pypi.org/project/physiopy-community-guidelines/)
5323
[![Auto Release](https://img.shields.io/badge/release-auto.svg?colorA=888888&colorB=9B065A&label=auto)](https://github.com/intuit/auto)
54-
[![Supports python version](https://img.shields.io/pypi/pyversions/<reponame>)](https://pypi.org/project/<reponame>/)
5524

5625
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
5726
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat)](#contributors)
5827
<!-- ALL-CONTRIBUTORS-BADGE:END -->
5928

60-
``<reponame>`` is a python3 library meant to do something.
61-
62-
> If you use ``<reponame>`` in your work, please support it by citing the zenodo DOI of the version you used. You can find the latest version [here](https://doi.org/10.5281/zenodo.3470091)
63-
64-
> We also support gathering all relevant citations via [DueCredit](http://duecredit.org).
29+
> If you use ``physiopy-community-guidelines`` in your work, please support it by citing the zenodo DOI of the version you used. You can find the latest version [here](https://doi.org/10.5281/zenodo.3470091)
6530
66-
[Read the latest documentation](https://<reponame>.readthedocs.io/en/latest/) for more information on <reponame>!
6731

68-
## Tested OSs
69-
We woudl love to do that, but for teh moment we cannot support **Windows or MacOS testing**. The reason is related to the cost of running such tests: for each non-Linux test, we can run up to 8 tests on Linux instead. Partial Windows and MacOS testing might be introduced in future releases.
70-
71-
Hence, while **we cannot ensure that <reponame> will run on Windows or MacOS**, however we don't see any reason it shouldn't.
72-
Besides, it will run on Windows Linux Subsistems.
73-
74-
We apologise for the discomfort.
75-
76-
77-
<!-- ## Hacktoberfest
78-
Hacktoberfest participants, welcome!
79-
We have some issues for you [here](https://github.com/physiopy/<reponame>/issues?q=is%3Aissue+is%3Aopen+label%3Ahacktoberfest)!
80-
However, feel free to tackle any issue you'd like. Depending on the issue and extent of contribution, Hacktoberfest related PRs might not count toward being listed as contributors and authors (unless there is the specific interest). You can ask about it in the issue itself!
81-
Feel free to ask help to the contributors over gitter, happy coding and (hopefully) enjoy hour tee (or tree)!
82-
83-
## The BrainWeb
84-
BrainWeb participants, welcome!
85-
We have a milestone [here](https://github.com/physiopy/<reponame>/milestone/5) as a collection of issues you could work on with our help.
86-
Check the issues with a `BrainWeb` label. Of course, they are only suggestions, so feel free to tackle any issue you want, even open new ones!
87-
You can also contact us on Gitter, in the BrainHack Mattermost (<a href="https://mattermost.brainhack.org/brainhack/channels/physiopy">#physiopy</a>), and don't hesitate to contact [Stefano](https://github.com/smoia) in other ways to jump in the development!
88-
-->
8932

9033
**We're looking for code contributors,** but any suggestion/bug report is welcome! Feel free to open issues!
9134

@@ -106,18 +49,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
10649
License
10750
-------
10851

109-
This template is released under The Unlicense. Commented here below a copy of the Apache 2.0 Licence, adopted by Physiopy.
110-
Remember to change the licence of your repository as soon as you adopt the template.
111-
<!-- Copyright 2019-2020, The Physiopy community.
112-
113-
Licensed under the Apache License, Version 2.0 (the "License");
114-
you may not use this file except in compliance with the License.
115-
You may obtain a copy of the License at
116-
117-
http://www.apache.org/licenses/LICENSE-2.0
118-
119-
Unless required by applicable law or agreed to in writing, software
120-
distributed under the License is distributed on an "AS IS" BASIS,
121-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
122-
See the License for the specific language governing permissions and
123-
limitations under the License. -->
52+
Copyright 2019-2024, The Physiopy Community
53+
This repository and all its content are licensed under the CC-BY-SA-4.0 license.

codecov.yml

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)