Skip to content

Commit 86f3785

Browse files
update after first release on pypi
1 parent ea2f2af commit 86f3785

File tree

7 files changed

+126
-62
lines changed

7 files changed

+126
-62
lines changed

README.md

Lines changed: 71 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,89 @@
1-
# test
1+
# dialoget - python library
2+
23
python.dialoget.com is a test framework for multilanguage source code, based on decorators
34

4-
## init
5+
The test directory structure for Python and Java projects will often follow conventions that are supported by popular testing frameworks and project management tools.
6+
Below, are typical structures for both languages, which help in organizing tests based on their type (e.g., unit tests, functional tests, integration tests).
7+
8+
9+
```
10+
dialoget/
11+
12+
├── src/
13+
│ └── dialoget.py # Python file with code for the package
14+
15+
├── tests/ # Unit tests for the package
16+
│ ├── dialoget.py
17+
│ └── test_module2.py
18+
19+
├── docs/ # Documentation for the package
20+
│ ├── conf.py
21+
│ ├── index.rst
22+
│ └── ...
23+
24+
├── README.md # README file with a description of the package, installation instructions, etc.
25+
├── LICENSE # License file specifying how the package can be used and shared
26+
├── setup.py # Setuptools script for installation and distribution of the package
27+
├── setup.cfg # Configuration settings for setuptools
28+
├── requirements.txt # File listing all dependencies for the package
29+
└── .gitignore # Specifies intentionally untracked files to ignore for git
30+
```
31+
32+
33+
34+
## Build
35+
build your package, first ensure you have the latest versions of `build` and `wheel` installed:
36+
37+
```shell
38+
pip install --upgrade build wheel
39+
```
40+
41+
## Install
42+
Run the build module from the root of the project where the `pyproject.toml` file is located:
43+
44+
```shell
45+
python -m build
46+
```
47+
48+
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`).
49+
50+
## Publish
51+
After the build completes successfully,
52+
upload your package to PyPI using `twine`:
53+
54+
```shell
55+
pip install --upgrade twine
56+
twine upload dist/*
57+
```
58+
59+
## Manual
60+
61+
62+
### init
563
```bash
664
pip install --upgrade pip
765
pip install requests
8-
pip install behave
966
pip install setuptools
10-
chmod +x test.sh
1167
```
1268

13-
## Start testing
14-
with one bash script
69+
70+
### Test
1571
```bash
16-
./test.sh
72+
pytest
73+
#python3 setup.py sdist bdist_wheel
1774
```
1875

19-
or each script in command line
2076

77+
### Build
2178
```bash
22-
cd test/dialoget
23-
python3 update_repo_on_github.py
24-
python3 update_repo_on_github2.py
25-
python3 create_repo_on_org_github.py
79+
python -m build
80+
#python3 setup.py sdist bdist_wheel
2681
```
2782

28-
29-
30-
The test directory structure for Python and Java projects will often follow conventions that are supported by popular testing frameworks and project management tools.
31-
Below, are typical structures for both languages, which help in organizing tests based on their type (e.g., unit tests, functional tests, integration tests).
32-
83+
### Publish
84+
``bash
85+
twine upload dist/*
86+
```
3387
3488
### Python
3589

pyproject.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[build-system]
2+
requires = [
3+
"setuptools>=42",
4+
"wheel",
5+
'requests >= 2',
6+
'setuptools >= 67.7.2'
7+
]
8+
build-backend = "setuptools.build_meta"

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
requests
2+
setuptools

setup.cfg

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[metadata]
2+
name = dialoget
3+
version = attr: dialoget.__version__
4+
description = A Sentence Python decorator for displaying dynamic log messages.
5+
long_description = file: README.md
6+
long_description_content_type = text/markdown
7+
author = Tom Sapletta
8+
author_email = [email protected]
9+
license = Apache-2.0
10+
license_files = LICENSE
11+
classifiers =
12+
Programming Language :: Python :: 3
13+
License :: OSI Approved :: Apache License
14+
15+
[options]
16+
package_dir =
17+
= src
18+
packages = find:
19+
python_requires = >=3.6
20+
21+
[options.packages.find]
22+
where = src

setup.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import requests
2+
import setuptools
3+
from setuptools import setup, find_packages
4+
5+
setup(
6+
name='dialoget',
7+
version='0.0.1',
8+
author='Tom Sapletta',
9+
author_email='[email protected]',
10+
packages=find_packages(),
11+
license='LICENSE',
12+
description='A Sentence decorator for dynamic log messages.',
13+
long_description=open('README.md').read(),
14+
long_description_content_type='text/markdown',
15+
install_requires=[
16+
'requests >= 2',
17+
'setuptools >= 67.7.2'
18+
],
19+
classifiers=[
20+
'Programming Language :: Python :: 3',
21+
'License :: OSI Approved :: MIT License',
22+
],
23+
)

test/behave/update_repo_on_github2.py

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

test/dialoget/create_repo_on_org_github.py

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

0 commit comments

Comments
 (0)