1
- # About
1
+ # Python Repo Template
2
+
3
+ ## About
2
4
This repo is basically my template for new repos/projects
3
5
4
- # CI Template:
6
+ ## CI Template
5
7
6
8
By default this template will assume that the GHA Service and Circle-CI Service are used for CI/CD
7
9
8
- # Status
10
+ ## Status
9
11
10
- ### master:
12
+ ### master
11
13
[ ![ CI] ( https://github.com/reactive-firewall/python-repo/actions/workflows/Tests.yml/badge.svg?branch=master )] ( https://github.com/reactive-firewall/python-repo/actions/workflows/Tests.yml )
12
14
[ ![ CircleCI] ( https://circleci.com/gh/reactive-firewall/python-repo/tree/master.svg?style=svg )] ( https://circleci.com/gh/reactive-firewall/python-repo/tree/master )
13
15
[ ![ status] ( https://travis-ci.org/reactive-firewall/python-repo.svg?branch=master )] ( https://travis-ci.org/reactive-firewall/python-repo )
@@ -24,7 +26,7 @@ By default this template will assume that the GHA Service and Circle-CI Service
24
26
![ Size] ( https://img.shields.io/github/languages/code-size/reactive-firewall/python-repo.svg )
25
27
![ commits-since] ( https://img.shields.io/github/commits-since/reactive-firewall/python-repo/stable.svg?maxAge=9000 )
26
28
27
- ### Stable:
29
+ ### Stable
28
30
[ ![ CI] ( https://github.com/reactive-firewall/python-repo/actions/workflows/Tests.yml/badge.svg?branch=stable&event=pull_request )] ( https://github.com/reactive-firewall/python-repo/actions/workflows/Tests.yml )
29
31
[ ![ CircleCI] ( https://circleci.com/gh/reactive-firewall/python-repo/tree/stable.svg?style=svg )] ( https://circleci.com/gh/reactive-firewall/python-repo/tree/stable )
30
32
[ ![ status] ( https://travis-ci.org/reactive-firewall/python-repo.svg?branch=stable )] ( https://travis-ci.org/reactive-firewall/python-repo )
@@ -34,7 +36,7 @@ By default this template will assume that the GHA Service and Circle-CI Service
34
36
[ ![ Coverage Status] ( https://coveralls.io/repos/github/reactive-firewall/python-repo/badge.svg?branch=stable )] ( https://coveralls.io/github/reactive-firewall/python-repo?branch=stable )
35
37
[ ![ codebeat badge] ( https://codebeat.co/badges/87520e4a-6d24-4e98-a61e-6e9efc58f783 )] ( https://codebeat.co/projects/github-com-reactive-firewall-python-repo-stable )
36
38
37
- # How do I use this to create a new project repo?
39
+ ### How do I use this to create a new project repo?
38
40
39
41
(assuming new project is already forked on github to ` MY-NEW-REPO ` )
40
42
@@ -44,7 +46,7 @@ git clone https://github.com/reactive-firewall/MY-NEW-REPO.git MY-NEW-REPO
44
46
# cd ./MY-NEW-REPO
45
47
```
46
48
47
- # Dev Testing Template:
49
+ ### Dev Testing Template
48
50
49
51
In a rush? Then use this:
50
52
@@ -70,11 +72,11 @@ make test-tox ; # runs the tox tests
70
72
make clean ; # cleans up for next test
71
73
```
72
74
73
- # Documentation
75
+ ### Documentation
74
76
75
77
For more details read the project [ documentation] ( ./docs/index ) .
76
78
77
- # Next steps:
79
+ ### Next steps
78
80
79
81
Like automation? Then integrate away, this template can take it!
80
82
(hint: @coderabbitai , @travis-ci , @houndci-bot , @pyup-bot , @circleci , @codecov-io , @lemurheavy , @coverallsapp , @codeclimate )
0 commit comments