Skip to content

Commit 84572a7

Browse files
update docs
1 parent fa130de commit 84572a7

File tree

3 files changed

+96
-28
lines changed

3 files changed

+96
-28
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# dialoget - python library
1+
# [dialoget](htttp://www.dialoget.com) - python library
2+
3+
[![PyPI](https://img.shields.io/pypi/v/dialoget?style=flat-square)](https://pypi.org/project/dialoget/)
4+
[![Supported Python versions](https://img.shields.io/pypi/pyversions/dialoget.svg)](https://pypi.org/project/dialoget/)
5+
[![Downloads](https://static.pepy.tech/badge/dialoget/month)](https://pepy.tech/project/dialoget)
6+
[![check](https://github.com/dialoget/python/actions/workflows/check.yml/badge.svg)](https://github.com/dialoget/python/actions/workflows/check.yml)
7+
[![Documentation Status](https://docs.org/dialoget/python/badge/?version=latest)](https://docs.dialoget.com/en/latest/?badge=latest)
28

39
python.dialoget.com is a test framework for multilanguage source code, based on decorators
410

@@ -33,7 +39,7 @@ dialoget/
3339
## Usage
3440

3541
```bash
36-
pip install dialoget==0.0.1
42+
pip install dialoget
3743
```
3844

3945

@@ -88,21 +94,28 @@ To update a release of a Python package, you'll typically go through the followi
8894

8995
5. Tag the commit with the version number:
9096
```shell
91-
git tag -a v0.1.3 -m "Release version 0.1.3"
97+
git tag -a v0.1.7 -m "Release version 0.1.7"
9298
git push --tags
9399
```
94100

95101
## Build
102+
+ [build 1.0.3](https://pypa-build.readthedocs.io/en/latest/)
96103

97104
Build the new distribution files for the package using your chosen build tool, typically the build package:
98105
Run the build module from the root of the project where the `pyproject.toml` file is located:
99106
This command will generate distribution files in the newly created `dist/` directory within your project. You will find both a source archive (`.tar.gz`) and a wheel file (`.whl`).
100107
```shell
101108
pip install build
102-
python -m build --version 0.1.3
109+
python -m build --version 0.1.5
110+
python -m build
103111
```
104112

105113

114+
+ [Versioning - Hatch](https://hatch.pypa.io/latest/version/)
115+
```bash
116+
hatch version release
117+
```
118+
106119
### Publish
107120
After the build completes successfully, upload the new distribution files to the Python Package Index (PyPI).
108121
Upload your package to PyPI using `twine`
@@ -112,6 +125,8 @@ Upload your package to PyPI using `twine`
112125

113126
### Github Release
114127

128+
129+
115130
If your project is hosted on GitHub or a similar platform, you may also want to create a GitHub release:
116131
- Go to the "Releases" section of your repository.
117132
- Draft a new release, using the new tag you've created.

TODO.md

Whitespace-only changes.

pyproject.toml

Lines changed: 77 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
requires = [
33
"hatch-vcs>=0.4",
44
"hatchling>=1.18",
5+
"hatch-requirements-txt",
6+
"setuptools ~=63.2.0",
7+
"wheel ~=0.37.1",
58
]
69
build-backend = "hatchling.build"
7-
8-
[tool.setuptools.dynamic]
9-
name = "dialoget"
10-
version = "attr: dialoget.__version__"
10+
#build-backend = "setuptools.build_meta"
1111

1212

1313
[project.urls]
@@ -19,20 +19,43 @@ wiki = "https://github.com/dialoget/python/wiki"
1919

2020
[project]
2121
name = "dialoget"
22-
dynamic = ["version"]
23-
authors = [
24-
{ name = "Tom Sapletta", email = "[email protected]" },
25-
]
26-
maintainers = [
27-
{ name = "dialoget developers", email = "[email protected]" }
28-
]
29-
requires-python = ">=3.7"
22+
version = "0.1.7"
23+
#dynamic = ["dependencies"]
24+
#dynamic = ["version"]
3025
description = "A Sentence Python decorator for displaying dynamic log messages."
3126
readme.content-type = "text/markdown"
3227
readme.file = "README.md"
3328
keywords = ["test", "framework", "doalogware", "Sentence", "console", "terminal", "time"]
3429
license = "Apache-2.0"
30+
requires-python = ">=3.7"
3531

32+
dependencies = [
33+
"packaging>=23.2",
34+
'tomli>=2.0.1; python_version < "3.11"',
35+
"stringcase ~=1.2.0",
36+
]
37+
optional-dependencies.docs = [
38+
"furo>=2023.9.10",
39+
"sphinx<7.2",
40+
"sphinx-autodoc-typehints>=1.25.2",
41+
"pylint ~=2.14.0",
42+
"toml ~=0.10.2",
43+
"yapf ~=0.32.0",
44+
]
45+
optional-dependencies.testing = [
46+
"covdefaults>=2.3",
47+
"pytest>=7.4.3",
48+
"pytest-cov>=4.1",
49+
"pytest-mock>=3.12",
50+
"setuptools>=69.0.2",
51+
"wheel>=0.42",
52+
]
53+
authors = [
54+
{ name = "Tom Sapletta", email = "[email protected]" },
55+
]
56+
maintainers = [
57+
{ name = "dialoget developers", email = "[email protected]" }
58+
]
3659
classifiers = [
3760
"Development Status :: 5 - Production/Stable",
3861
"Environment :: Console",
@@ -87,10 +110,22 @@ classifiers = [
87110
"Topic :: System :: Shells",
88111
"Topic :: Terminals",
89112
"Topic :: Utilities"]
90-
dependencies = []
91113

92-
[project.scripts]
93-
dialoget = "dialoget.cli:main"
114+
115+
[tool.hatch.metadata.hooks.requirements_txt]
116+
#files = ["requirements.txt"]
117+
118+
[tool.pylint]
119+
max-line-length = 88
120+
disable = [
121+
"C0103", # (invalid-name)
122+
"C0114", # (missing-module-docstring)
123+
"C0115", # (missing-class-docstring)
124+
"C0116", # (missing-function-docstring)
125+
"R0903", # (too-few-public-methods)
126+
"R0913", # (too-many-arguments)
127+
"W0105", # (pointless-string-statement)
128+
]
94129

95130
[tool.flake8]
96131
max_line_length = 99
@@ -114,14 +149,29 @@ multi_line_output = 4
114149
known_first_party = ["src", "tests"]
115150

116151
[tool.coverage.run]
117-
branch = true
118-
include = ["dialoget/*"]
119-
relative_files = true
120-
disable_warnings = ["include-ignored"]
152+
#branch = true
153+
#include = ["dialoget/*"]
154+
#relative_files = true
155+
#disable_warnings = ["include-ignored"]
156+
source = ["src"]
121157

122158
[tool.coverage.report]
123159
show_missing = true
124160

161+
[tool.coverage]
162+
html.show_contexts = true
163+
html.skip_covered = false
164+
paths.source = [
165+
"src",
166+
".tox*/*/lib/python*/site-packages",
167+
".tox*/pypy*/site-packages",
168+
".tox*\\*\\Lib\\site-packages",
169+
"*/src",
170+
"*\\src",
171+
]
172+
173+
[tool.black]
174+
line-length = 120
125175

126176
[tool.ruff]
127177
src = ["src", "tests"]
@@ -135,9 +185,12 @@ show_error_codes = true
135185
strict = true
136186
overrides = [{ module = ["virtualenv.*"], ignore_missing_imports = true }]
137187

138-
[tool.hatch]
139-
build.hooks.vcs.version-file = "src/__init__.py"
140-
version.source = "vcs"
188+
[tool.hatch.version]
189+
path = "src/__init__.py"
190+
#pattern = "BUILD = 'b(?P<version>[^']+)'"
141191

142-
[tool.black]
143-
line-length = 120
192+
[tool.setuptools.dynamic]
193+
version = { attr = "my_package.VERSION" }
194+
readme = { file = ["README.md", "TODO.md"] }
195+
196+
[tool.setuptools_scm]

0 commit comments

Comments
 (0)