Skip to content

Commit b9f10e6

Browse files
committed
change to pyproject.toml format and setuptools backend
1 parent f5d38a2 commit b9f10e6

File tree

6 files changed

+59
-71
lines changed

6 files changed

+59
-71
lines changed

Pipfile

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

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,22 +110,26 @@ In python ecosystem:
110110

111111
## Development
112112

113-
To develop pydifact, clone the repository and install the dev requirements with `pipenv install --dev`. This installs all the python packages needed for development and testing.
114-
Alternatively, if you are using `pip` run the following commands:
113+
### Setup
114+
To develop pydifact, clone the repository and install the dev requirements:
115115

116116
```
117-
pip install -e .
118-
pip install -r requirements-dev.txt
117+
pip install -e .[dev]
119118
```
120119

121-
Format all python files using [black](https://black.readthedocs.io).
120+
This installs all the python packages needed for development and testing.
121+
122+
### Code formatting
123+
124+
Format all python files using [black](https://black.readthedocs.io) before committing.
122125

123-
Happy coding, PR are more than welcome to make this library better, or to add a feature that matches your needs. Nevertheless, don't forget adding tests for every aspect you add in code.
126+
Happy coding, PR are more than welcome to make this library better, or to add a feature that matches your needs.
127+
Nevertheless, don't forget adding tests for every aspect you add in code.
124128

125129
### Testing
126130

127131
pydifact uses [pytest](http://pytest.org) for testing.
128-
Just exec `pytest` within the project folder to execute the unit tests.
132+
Just exec `pytest` within the project folder to execute the unit tests. Make sure you installed the library properly before using `pip install -e .[dev]`.
129133

130134
There is one test to check the performance of parsing huge files, named `test_huge_message` - you can skip that test by calling
131135

pyproject.toml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
[project]
2+
name = "pydifact"
3+
dynamic = ["version"]
4+
authors = [{ name = "Christian González", email = "[email protected]" }]
5+
license = { "file" = "LICENSE" }
6+
description = "Pydifact is a library that aims to provide complete support for reading and writing EDIFACT files. These file format, despite being old, is still a standard in many business cases. In Austria e.g., it is used for the transfer of medical reports between medical doctors."
7+
readme = "README.md"
8+
classifiers = [
9+
"Development Status :: 3 - Alpha",
10+
"Environment :: Console",
11+
"Intended Audience :: Developers",
12+
"License :: OSI Approved :: MIT License",
13+
"Natural Language :: English",
14+
"Operating System :: MacOS :: MacOS X",
15+
"Operating System :: Microsoft :: Windows",
16+
"Operating System :: POSIX",
17+
"Programming Language :: Python :: 3",
18+
"Topic :: Software Development :: Libraries"
19+
]
20+
requires-python = ">=3.8"
21+
22+
[dependencies]
23+
# none
24+
25+
[project.optional-dependencies]
26+
dev = [
27+
"pytest>=8.0.1",
28+
"pytest-cov>=4.1.0",
29+
"pytest-profiling>=1.7.0",
30+
"keyring>=24.3.0",
31+
"Sphinx>=7.2.0",
32+
"setuptools>=69.1.0",
33+
"wheel>=0.42.0",
34+
"black>=24.0.0",
35+
"sphinx-rtd-theme>=2.0.0"
36+
]
37+
38+
[project.urls]
39+
Documentation = "https://pydifact.readthedocs.io"
40+
Repository = "https://github.com/nerdocs/pydifact"
41+
Issues = "https://github.com/nerdocs/pydifact/issues"
42+
43+
[build-system]
44+
requires = ["setuptools>=61.0.0", "wheel"]
45+
build-backend = "setuptools.build_meta"
46+
47+
[tool.setuptools.dynamic]
48+
version = {attr = "pydifact.__version__"}

requirements-dev.txt

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

setup.cfg

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

setup.py

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

0 commit comments

Comments
 (0)