Skip to content

Commit

Permalink
feat(demo): changed template so less has to be changed when copying repo
Browse files Browse the repository at this point in the history
  • Loading branch information
robinvandernoord committed May 1, 2023
1 parent 2104745 commit fad7a3c
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.pyc
.idea
venv*
dist/
build/
Empty file added CHANGELOG.md
Empty file.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,26 @@
- [Installation](#installation)
- [License](#license)

## USING THIS TEMPLATE REPOSITORY
1. remove this markdown section;
2. replace 'demo' in README.md, pyproject.toml and the name of the plugin in `src` to your actual plugin name;
3. (add your actual plugin code of course);
4. run `semantic-release publish`, `hatch build -c` and `hatch publish`.

## Installation

```console
pip install edwh-demo-plugin
```

But probably you want to install the whole edwh package:

```console
pipx install edwh[demo]
# or
pipx install edwh[plugins,omgeving]
```

## License

`edwh-demo-plugin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
28 changes: 23 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,31 @@ name = "edwh-demo-tasks-plugin"
dynamic = ["version"]
description = 'Demo project with a plugin to be discovered from the edwh package'
readme = "README.md"
requires-python = ">=3.7"
requires-python = ">=3.10"
license = "MIT"
keywords = []
authors = [
{ name = "Remco Boerma", email = "[email protected]" },
{ name = "Robin van der Noord", email = "[email protected]" },
]
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]
dependencies = ['invoke']

[project.optional-dependencies]
dev = [
"hatch",
# "python-semantic-release",
"black",
]

[project.urls]
Documentation = "https://github.com/remcoboerma/edwh-demo-tasks-plugin#readme"
Issues = "https://github.com/remcoboerma/edwh-demo-tasks-plugin/issues"
Expand All @@ -38,6 +44,18 @@ demo = "edwh_demo_plugin.demo_plugin"
[tool.hatch.version]
path = "src/edwh_demo_plugin/__about__.py"

[tool.semantic_release]
branch = "master"
version_variable = "src/edwh_demo_plugin/__about__.py:__version__"
change_log = "CHANGELOG.md"
upload_to_repository = false
upload_to_release = false
build_command = "hatch build"

parser_angular_minor_types = "feat,minor"
parser_angular_patch_types = "fix,perf,refactor,build,chore,patch"


[tool.hatch.envs.default]
dependencies = [
"coverage[toml]>=6.5",
Expand All @@ -56,7 +74,7 @@ cov = [
]

[[tool.hatch.envs.all.matrix]]
python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
python = ["3.10", "3.11", "3.12"]

[tool.hatch.envs.lint]
detached = true
Expand Down
2 changes: 1 addition & 1 deletion src/edwh_demo_plugin/__about__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2023-present Remco Boerma <[email protected]>
#
# SPDX-License-Identifier: MIT
__version__ = "0.0.3"
__version__ = "0.0.0"

0 comments on commit fad7a3c

Please sign in to comment.