Skip to content

Commit 40e9fcf

Browse files
readme update and code cleanup
1 parent d1e8f6a commit 40e9fcf

File tree

10 files changed

+816
-315
lines changed

10 files changed

+816
-315
lines changed

.github/workflows/python-publish.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# This workflow will upload a Python Package to PyPI when a release is created
2-
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3-
4-
# This workflow uses actions that are not certified by GitHub.
5-
# They are provided by a third-party and are governed by
6-
# separate terms of service, privacy policy, and support
7-
# documentation.
8-
91
name: Upload Python Package
102

113
on:

.vscode/settings.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"python.testing.pytestArgs": [
3+
"tests"
4+
],
5+
"python.testing.unittestEnabled": false,
6+
"python.testing.pytestEnabled": true
7+
}

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
3+
All notable changes to the "pyprintf" sprintf() implementation will be documented in this file.
4+
5+
## [0.0.2] - 2025-04-10
6+
7+
## [0.0.1] - 2025-04-10

README.md

Lines changed: 327 additions & 13 deletions
Large diffs are not rendered by default.

pyproject.toml

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,22 @@ authors = [
55
classifiers = [
66
"Development Status :: 5 - Production/Stable",
77
"Intended Audience :: Developers",
8+
"Intended Audience :: Information Technology",
89
"Natural Language :: English",
9-
"Programming Language :: Python :: 3 :: Only",
10-
"Programming Language :: Python :: 3.9",
10+
"Operating System :: OS Independent",
11+
"Programming Language :: Python :: 3",
1112
"Programming Language :: Python :: 3.10",
12-
"Programming Language :: Python :: 3.11",
13+
"Programming Status :: Python :: 3.11",
1314
"Programming Language :: Python :: 3.12",
1415
"Programming Language :: Python :: 3.13",
16+
"Topic :: Software Development :: Libraries",
17+
"Topic :: Software Development :: Libraries :: Python Modules",
18+
"Topic :: Text Processing :: General",
19+
"Typing :: Typed",
20+
"Framework :: Pytest",
1521
]
1622
dependencies = [
17-
"typing-extensions>=4.0.0",
23+
"typing-extensions>=4.0.0; python_version<'3.11'",
1824
]
1925
description = "A lightweight, Open Source pyprintf sprintf() implementation written in Python"
2026
keywords = [
@@ -40,8 +46,12 @@ version = "0.0.2"
4046
"Homepage" = "https://github.com/playfulsparkle/pyprintf"
4147

4248
[build-system]
43-
requires = ["setuptools>=65.0.0", "wheel"]
4449
build-backend = "setuptools.build_meta"
50+
requires = ["setuptools>=65.0.0", "wheel"]
4551

4652
[project.optional-dependencies]
47-
dev = ["pytest>=7.1", "flake8>=4.0"]
53+
test = [
54+
"pytest>=8.3.0",
55+
"pytest-cov>=4.1.0",
56+
"flake8>=7.0.0",
57+
]

requirements.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
setuptools
2-
pytest
3-
flake8
1+
typing-extensions>=4.0.0

src/pyprintf/__init__.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
#!/usr/bin/env python
22
# -*- coding: utf-8 -*-
3-
from .core import (
4-
sprintf,
5-
vsprintf,
6-
config,
7-
PyPrintfConfig
8-
)
3+
"""
4+
Package initialization file for pyprintf string formatting library.
95
10-
__all__ = ['sprintf', 'vsprintf', 'config', 'PyPrintfConfig']
11-
__version__ = '0.0.2'
6+
Exposes core functionality at the package level and defines version information.
7+
"""
8+
9+
from .core import sprintf, vsprintf, config
10+
11+
__all__ = ["sprintf", "vsprintf", "config"]
12+
__version__ = "0.0.2"

0 commit comments

Comments
 (0)