modernpackage 0.0.1.dev2__tar.gz → 0.0.3__tar.gz

{modernpackage-0.0.1.dev2 → modernpackage-0.0.3}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.3
 Name: modernpackage
-Version: 0.0.1.dev2
-Summary: Example package configuration using bleeding edge toolset
+Version: 0.0.3
+Summary: Package configuration example using bleeding edge toolset.
 Project-URL: homepage, https://github.com/albertas/modernpackage
-Author-email: Albertas Gimbutas <albertasgim@gmail.com>
+Author-email: Name Surname <email@example.com>
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
@@ -22,16 +22,18 @@ Requires-Dist: ruff; extra == 'test'
 Description-Content-Type: text/markdown
 
 # modernpackage
-This package is configured using bleeding edge toolset and serves as an
-example/starting point for another new packages.
+This is a boilerplate with bleeding edge linters for a new python package, just run:
+- `git clone git@github.com:albertas/modernpackage.git <your-package-name>`
+- `cd <your-package-name>`
+- `make init <your-package-name>` - to start your modern package.
 
 ## Development
 Commonly used commands for package development:
-`make check` - run unit tests and linters.
-`make fix` - format code and fix detected fixable issues.
-`make publish` - publishes current package version to pypi.org.
-`make compile` - bump and freeze dependency versions in requirements*.txt files
-`make sync` - upgrade installed dependencies in Virtual Environment (executed after `make compile`)
+- `make check` - run unit tests and linters.
+- `make fix` - format code and fix detected fixable issues.
+- `make publish` - publishes current package version to pypi.org.
+- `make compile` - bump and freeze dependency versions in requirements*.txt files
+- `make sync` - upgrade installed dependencies in Virtual Environment (executed after `make compile`)
 
 ## Toolset
 This package uses these cutting edge tools:
@@ -45,3 +47,12 @@ This package uses these cutting edge tools:
 - uv - for Python virtual environment and dependency management
 - pyproject.toml - configuration file for all tools
 - Makefile - aliases for commonly used command line commands
+
+## Feature requests:
+- make a cli command: this package should be installable. Ideally this flow should work:
+  - `pip install modernpackage`
+  - `modernpackage mynewpackage`
+  - `cd mynewpackage` && `make check` && `make publish`
+- Enable github and gitlab pipeline files to run `make check` in the pipeline.
+- Add pre-commit hooks with all the tools enabled.
+- codspeed.io could be considered for Continuous integration pipeline

modernpackage-0.0.3/README.md

@@ -0,0 +1,35 @@
+# modernpackage
+This is a boilerplate with bleeding edge linters for a new python package, just run:
+- `git clone git@github.com:albertas/modernpackage.git <your-package-name>`
+- `cd <your-package-name>`
+- `make init <your-package-name>` - to start your modern package.
+
+## Development
+Commonly used commands for package development:
+- `make check` - run unit tests and linters.
+- `make fix` - format code and fix detected fixable issues.
+- `make publish` - publishes current package version to pypi.org.
+- `make compile` - bump and freeze dependency versions in requirements*.txt files
+- `make sync` - upgrade installed dependencies in Virtual Environment (executed after `make compile`)
+
+## Toolset
+This package uses these cutting edge tools:
+- ruff - for linting and code formatting
+- mypy - for type checking
+- pip-audit - for known vulnerability detection in dependencies
+- deadcode - for unused code detection
+- pytest - for collecting and running unit tests
+- coverage - for code coverage by unit tests
+- hatch - for publishing package to pypi.org
+- uv - for Python virtual environment and dependency management
+- pyproject.toml - configuration file for all tools
+- Makefile - aliases for commonly used command line commands
+
+## Feature requests:
+- make a cli command: this package should be installable. Ideally this flow should work:
+  - `pip install modernpackage`
+  - `modernpackage mynewpackage`
+  - `cd mynewpackage` && `make check` && `make publish`
+- Enable github and gitlab pipeline files to run `make check` in the pipeline.
+- Add pre-commit hooks with all the tools enabled.
+- codspeed.io could be considered for Continuous integration pipeline

{modernpackage-0.0.1.dev2 → modernpackage-0.0.3}/modernpackage/__init__.py

@@ -1 +1,3 @@
 """Example package configuration using bleeding edge toolset."""
+
+__version__ = '0.0.3'

modernpackage-0.0.3/modernpackage/main.py

@@ -0,0 +1,42 @@
+"""Example package configuration using bleeding edge toolset."""
+
+from argparse import ArgumentParser, Namespace
+from modernpackage import __version__
+from subprocess import Popen, PIPE
+import os
+
+
+def parse_args() -> Namespace:
+    parser = ArgumentParser()
+    parser.add_argument('-v', '--version', help='Show package version.',
+                        action='store_true', default=False)
+    parser.add_argument('package_name', help='Name of a new pacakge to initialise in a local directory.', nargs='?')
+    parsed_args = parser.parse_args()
+    return parsed_args
+
+
+def init_new_package(package_name: str) -> None:
+    """Copy this package file to current dir as `package_name` and run `make init` in it."""
+
+    from_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    new_package_path = os.path.join(os.getcwd(), package_name)
+
+    print("Copying files from", from_path, "to", new_package_path, "..")
+    pipe = Popen(["cp", "-r", from_path, new_package_path], stdin=PIPE, stdout=PIPE)
+    pipe.communicate()[0]
+
+    pipe = Popen(["make", "init", package_name], stdin=PIPE, stdout=PIPE, cwd=new_package_path)
+    output = pipe.communicate()[0].decode()
+    print(output)
+
+
+def main() -> None:
+    """Return 'Hello world!' or package version if -v option is provided."""
+
+    parsed_args = parse_args()
+
+    if parsed_args.version:
+        print(f"modernpackage {__version__}")
+
+    elif parsed_args.package_name:
+        init_new_package(package_name=parsed_args.package_name)

{modernpackage-0.0.1.dev2 → modernpackage-0.0.3}/pyproject.toml

@@ -1,10 +1,9 @@
 [project]
 name = "modernpackage"
-version = "0.0.1.dev2"
 authors = [
-    {name = "Albertas Gimbutas", email = "albertasgim@gmail.com"},
+    {name = "Name Surname", email = "email@example.com"},
 ]
-description = "Example package configuration using bleeding edge toolset"
+description = "Package configuration example using bleeding edge toolset."
 readme = "README.md"
 requires-python = ">= 3.11"
 classifiers = [
@@ -15,13 +14,15 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.11",
 ]
-dependencies = [
-]
-
+dynamic = ["version"]
+dependencies = []
 
 [project.urls]
 homepage = "https://github.com/albertas/modernpackage"
 
+[project.scripts]
+modernpackage = "modernpackage.main:main"
+
 [project.optional-dependencies]
 test = [
     "hatch",
@@ -33,6 +34,8 @@ test = [
     "pytest-cov",
 ]
 
+[tool.pytest.ini_options]
+addopts = "--cov=. --no-cov-on-fail --cov-fail-under=90.0"
 
 [build-system]
 requires = ["hatchling"]
@@ -42,6 +45,8 @@ build-backend = "hatchling.build"
 include = ["**/*.py"]
 exclude = ["tests/**"]
 
+[tool.hatch.version]
+path = "modernpackage/__init__.py"
 
 [tool.ruff]  # https://docs.astral.sh/ruff/settings/
 line-length = 88
@@ -56,18 +61,18 @@ docstring-code-format = true
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-    "D203",  # one-blank-line-before-class
-    "D213",  # multi-line-summary-second-line
-    "COM812",  # missing-trailing-comma
-    "ISC001",  # single-line-implicit-string-concatenation
+    "D203",    # one blank line before class
+    "D213",    # multi line summary second line
+    "COM812",  # missing trailing comma
+    "ISC001",  # single line implicit string concatenation
     "ANN101",  # deprecated requirement to annotate self
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["S101", "D"]  # allow asserts and no docs in tests
+"tests/*" = ["S101", "D"] # allow assert and no docs in tests
 
 [tool.mypy]
-exclude = ["build", "dist", ".venv", "tests"]
+exclude = ["build", "dist", ".venv"]
 python_version = "3.11"
 strict = true
 pretty = true
@@ -76,9 +81,6 @@ show_error_codes = true
 warn_return_any = true
 warn_unused_configs = true
 
-[tool.pytest.ini_options]
-addopts = "--cov=. --no-cov-on-fail --cov-fail-under=90.0"
-
 [tool.deadcode]
 ignore_names = [
     "main",

modernpackage-0.0.1.dev2/README.md

@@ -1,24 +0,0 @@
-# modernpackage
-This package is configured using bleeding edge toolset and serves as an
-example/starting point for another new packages.
-
-## Development
-Commonly used commands for package development:
-`make check` - run unit tests and linters.
-`make fix` - format code and fix detected fixable issues.
-`make publish` - publishes current package version to pypi.org.
-`make compile` - bump and freeze dependency versions in requirements*.txt files
-`make sync` - upgrade installed dependencies in Virtual Environment (executed after `make compile`)
-
-## Toolset
-This package uses these cutting edge tools:
-- ruff - for linting and code formatting
-- mypy - for type checking
-- pip-audit - for known vulnerability detection in dependencies
-- deadcode - for unused code detection
-- pytest - for collecting and running unit tests
-- coverage - for code coverage by unit tests
-- hatch - for publishing package to pypi.org
-- uv - for Python virtual environment and dependency management
-- pyproject.toml - configuration file for all tools
-- Makefile - aliases for commonly used command line commands

modernpackage-0.0.1.dev2/modernpackage/main.py

@@ -1,6 +0,0 @@
-"""Example package configuration using bleeding edge toolset."""
-
-
-def main() -> str:
-    """Return 'Hello world'."""
-    return 'Hello world'