Skip to content

Commit aa5afb5

Browse files
committed
Update README, initialize and pyproject.toml, Add COPYING
1 parent 6dcfd11 commit aa5afb5

File tree

6 files changed

+719
-17
lines changed

6 files changed

+719
-17
lines changed

CODEOWNERS

Lines changed: 0 additions & 1 deletion
This file was deleted.

COPYING

Lines changed: 675 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
1-
# python-template
2-
General Python Project Template
3-
*Version December 29th, 2019*
1+
***THIS IS A TEMPLATE***
42

5-
[![test-action](https://github.com/JimFawkes/python-template/workflows/run_tests/badge.svg)](https://github.com/JimFawkes/python-template/actions)
6-
[![codecov](https://codecov.io/gh/JimFawkes/python-template/branch/master/graph/badge.svg)](https://codecov.io/gh/JimFawkes/python-template)
3+
# <PROJECTNAME>
4+
<DESCRIPTION>
5+
6+
7+
[![test-action](https://github.com/JimFawkes/<PROJECTNAME>/workflows/run_tests/badge.svg)](https://github.com/JimFawkes/<PROJECTNAME>/actions)
8+
[![codecov](https://codecov.io/gh/JimFawkes/<PROJECTNAME>/branch/master/graph/badge.svg)](https://codecov.io/gh/JimFawkes/<PROJECTNAME>)
9+
![python](https://img.shields.io/badge/python-3.8-blue)
10+
[![black](https://github.com/JimFawkes/<PROJECTNAME>/workflows/Lint/badge.svg)](https://github.com/JimFawkes/<PROJECTNAME>/actions)
11+
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](COPYING)
12+
[![Latest Tag](https://img.shields.io/github/v/tag/jimfawkes/<PROJECTNAME>)](https://github.com/JimFawkes/<PROJECTNAME>/releases)
13+
[![CodeFactor](https://www.codefactor.io/repository/github/jimfawkes/<PROJECTNAME>/badge)](https://www.codefactor.io/repository/github/jimfawkes/<PROJECTNAME>)
14+
[![CodeQL](https://github.com/JimFawkes/<PROJECTNAME>/workflows/CodeQL/badge.svg)](https://github.com/JimFawkes/<PROJECTNAME>/actions)
715

initialize.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ update_project_name () {
1010
# Search entire project for the template_project_name and replace with
1111
# actual project name
1212
echo "Update Project name in files for $PROJECT_NAME"
13-
rg python-template -g '!.git/*' -g '!initialize.sh' --hidden --files-with-matches | xargs sed -i.bak "s/python-template/$PROJECT_NAME/g"
13+
rg python-template -g '!.git/*' -g '!initialize.sh' --hidden --files-with-matches | xargs sed -i.bak "s/<PROJECT_NAME>/$PROJECT_NAME/g"
1414
}
1515

1616
create_project_structure () {

pull_request_template.md

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

pyproject.toml

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
21
# NOTE: you have to use single-quoted strings in TOML for regular expressions.
32
# It's the equivalent of r-strings in Python. Multiline strings are treated as
43
# verbose regular expressions by Black. Use [ ] to denote a significant space
54
# character.
65

76
[tool.black]
8-
line-length = 120
7+
line-length = 100
98
target-version = ["py38"]
109
include = '\.pyi?$'
1110
exclude = '''
@@ -23,3 +22,32 @@ exclude = '''
2322
)/
2423
'''
2524

25+
[build-system]
26+
requires = ["flit_core >=2,<4"]
27+
build-backend = "flit_core.buildapi"
28+
29+
[tool.flit.metadata]
30+
module="<PROJECTNAME>"
31+
author="Moritz Eilfort"
32+
author-email="<PROJECTNAME>@jimfawkes.com"
33+
home-page="https://github.com/JimFawkes/<PROJECTNAME>"
34+
requires=[
35+
"<REQUIREMENTS>"
36+
]
37+
requires-python=">=3.8"
38+
description-file="README.md"
39+
classifiers=[
40+
"Intended Audience :: Developers",
41+
'Natural Language :: English',
42+
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
43+
"Programming Language :: Python :: 3.8",
44+
"Topic :: SoftwareDevelopment :: Libraries :: Python Modules",
45+
]
46+
47+
[tool.flit.metadata.requires-extra]
48+
test=[
49+
"<REQUIREMENTS>"
50+
]
51+
52+
[tool.flit.entrypoints.console_scripts]
53+
<PROJECTNAME>="<PROJECTNAME>.cli:cli"

0 commit comments

Comments
 (0)