instant-python 0.9.1__tar.gz → 0.9.2__tar.gz

{instant_python-0.9.1 → instant_python-0.9.2}/.github/workflows/release.yml

@@ -2,6 +2,8 @@ name: Release and Publish
 
 on:
   workflow_dispatch:
+  release:
+    types: [published]
 
 jobs:
   release:
@@ -23,7 +25,6 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          fetch-tags: true
           persist-credentials: false
 
       - name: 🔖 Create release
@@ -47,7 +48,7 @@ jobs:
     name: Publish to PyPI
     needs:
       - release
-    if: needs.release.outputs.released == 'true'
+    if: needs.release.outputs.released == 'true' || github.event_name == 'release'
     runs-on: ubuntu-latest
     environment: release
     permissions:

{instant_python-0.9.1 → instant_python-0.9.2}/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## v0.9.1 (2025-07-18)
+
+### 🪲 Bug Fixes
+
+- **cli**: Update command in tox.ini file to be able to make reference to new location for application entry point ([`a8baef2`](https://github.com/dimanu-py/instant-python/commit/a8baef2eb88018cb6a0210122348e753dc10cacb))
+
+- **templates**: Update pyproject.toml template to include optional build dependencies when github actions built-in feature is selected ([`b765ec8`](https://github.com/dimanu-py/instant-python/commit/b765ec81f3e61ce170873eaed371910e41e2e871))
+
+- **templates**: Update release action template to work running build command to update uv.lock ([`9824451`](https://github.com/dimanu-py/instant-python/commit/982445188567c61d31ffc11d04ccdab163fb1ee4))
+
+### ⚙️ Build System
+
+- Update changelog section in semantic release config ([`7a413cf`](https://github.com/dimanu-py/instant-python/commit/7a413cf7a95b4da30ef23efafdf94cb2e2118168))
+
+- Update application entry point ([`8b5330a`](https://github.com/dimanu-py/instant-python/commit/8b5330a99ae432dc0e04c19f67ccc55e5ee9fe5a))
+
+### ♻️ Refactoring
+
+- **cli**: Move cli files to its own folder ([`81b8c3c`](https://github.com/dimanu-py/instant-python/commit/81b8c3c3839bf548a5ffac3432615d392ad2a05e))
+
+- **templates**: Update name of test workflow ([`80225f5`](https://github.com/dimanu-py/instant-python/commit/80225f51014aef1d06660803aa0fec65633f41bd))
+
 ## v0.9.0 (2025-07-18)
 
 ### ✨ Features

{instant_python-0.9.1 → instant_python-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: instant-python
-Version: 0.9.1
+Version: 0.9.2
 Summary: Instant boilerplate generation for Python projects
 Project-URL: documentation, https://dimanu-py.github.io/instant-python/
 Project-URL: repository, https://github.com/dimanu-py/instant-python/

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/boilerplate/fastapi/success_response.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel
-from starlette.responses import JSONResponse
+from fastapi.responses import JSONResponse
 
 
 class SuccessResponse(BaseModel):

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/boilerplate/pytest.ini

@@ -4,7 +4,7 @@ markers =
     acceptance: mark a test as an acceptance test
     integration: mark a test as an integration test
 testpaths =
-    tests
+    test
 asyncio_default_fixture_loop_scope =
     function
 asyncio_mode = auto

instant_python-0.9.2/instant_python/templates/boilerplate/random_generator.py

@@ -0,0 +1,18 @@
+from faker import Faker
+
+
+class RandomGenerator:
+    faker = Faker()
+
+    @classmethod
+    def uuid(cls) -> str:
+        return cls.faker.uuid4()
+
+    @classmethod
+    def word(cls) -> str:
+        return cls.faker.word()
+
+
+    @classmethod
+    def positive_integer(cls, minimum: int = 0, maximum: int = 100) -> int:
+        return cls.faker.pyint(min_value=minimum, max_value=maximum)

instant_python-0.9.2/instant_python/templates/boilerplate/value_object/int_primitives_mother.py

@@ -0,0 +1,8 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template.name) %}
+from test.{{ template_domain_import }}.random_generator import RandomGenerator
+
+
+class IntPrimitivesMother:
+	@staticmethod
+	def any() -> int:
+		return RandomGenerator.positive_integer()

instant_python-0.9.2/instant_python/templates/boilerplate/value_object/string_primitives_mother.py

@@ -0,0 +1,8 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template.name) %}
+from test.{{ template_domain_import }}.random_generator import RandomGenerator
+
+
+class StringPrimitivesMother:
+	@staticmethod
+	def any() -> str:
+		return RandomGenerator.word()

instant_python-0.9.2/instant_python/templates/boilerplate/value_object/test_int_value_object.py

@@ -0,0 +1,85 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template.name) %}
+import pytest
+{% if dependencies | has_dependency("expects") %}
+from expects import expect, equal, raise_error
+{% endif %}
+
+from {{ general.source_name }}.{{ template_domain_import }}.errors.incorrect_value_type_error import (
+	IncorrectValueTypeError,
+)
+from {{ general.source_name }}.{{ template_domain_import }}.errors.invalid_negative_value_error import (
+	InvalidNegativeValueError,
+)
+from {{ general.source_name }}.{{ template_domain_import }}.errors.required_value_error import RequiredValueError
+from {{ general.source_name }}.{{ template_domain_import }}.value_objects.usables.int_value_object import (
+	IntValueObject,
+)
+from test.{{ template_domain_import }}.value_objects.int_primitives_mother import (
+	IntPrimitivesMother,
+)
+
+
+@pytest.mark.unit
+class TestIntValueObject:
+	{% if dependencies | has_dependency("expects") %}
+	def test_should_create_int_value_object(self) -> None:
+		value = IntPrimitivesMother.any()
+
+		integer = IntValueObject(value)
+
+		expect(integer.value).to(equal(value))
+
+	def test_should_raise_error_when_value_is_none(self) -> None:
+		expect(lambda: IntValueObject(None)).to(raise_error(RequiredValueError))
+
+	def test_should_raise_error_when_value_is_not_integer(self) -> None:
+		expect(lambda: IntValueObject("123")).to(raise_error(IncorrectValueTypeError))
+
+	def test_should_raise_error_if_int_value_is_negative(self) -> None:
+		expect(lambda: IntValueObject(-1)).to(raise_error(InvalidNegativeValueError))
+
+	def test_should_compare_equal_with_same_value(self) -> None:
+		common_value = IntPrimitivesMother.any()
+		first_integer = IntValueObject(common_value)
+		second_integer = IntValueObject(common_value)
+
+		expect(first_integer).to(equal(second_integer))
+
+	def test_should_not_be_equal_with_different_values(self) -> None:
+		first_integer = IntValueObject(IntPrimitivesMother.any())
+		second_integer = IntValueObject(IntPrimitivesMother.any())
+
+		expect(first_integer).to_not(equal(second_integer))
+	{% else %}
+	def test_should_create_int_value_object(self) -> None:
+		value = IntPrimitivesMother.any()
+
+		integer = IntValueObject(value)
+
+		assert integer.value == value
+
+	def test_should_raise_error_when_value_is_none(self) -> None:
+		with pytest.raises(RequiredValueError):
+			IntValueObject(None)
+
+	def test_should_raise_error_when_value_is_not_integer(self) -> None:
+		with pytest.raises(IncorrectValueTypeError):
+			IntValueObject("123")
+
+	def test_should_raise_error_if_int_value_is_negative(self) -> None:
+		with pytest.raises(InvalidNegativeValueError):
+			IntValueObject(-1)
+
+	def test_should_compare_equal_with_same_value(self) -> None:
+		common_value = IntPrimitivesMother.any()
+		first_integer = IntValueObject(common_value)
+		second_integer = IntValueObject(common_value)
+
+		assert first_integer == second_integer
+
+	def test_should_not_be_equal_with_different_values(self) -> None:
+		first_integer = IntValueObject(IntPrimitivesMother.any())
+		second_integer = IntValueObject(IntPrimitivesMother.any())
+
+		assert first_integer != second_integer
+	{% endif %}

instant_python-0.9.2/instant_python/templates/boilerplate/value_object/test_string_value_object.py

@@ -0,0 +1,75 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template.name) %}
+import pytest
+{% if dependencies | has_dependency("expects") %}
+from expects import expect, equal, raise_error
+{% endif %}
+
+from {{ general.source_name }}.{{ template_domain_import }}.errors.incorrect_value_type_error import (
+	IncorrectValueTypeError,
+)
+from {{ general.source_name }}.{{ template_domain_import }}.errors.required_value_error import RequiredValueError
+from {{ general.source_name }}.{{ template_domain_import }}.value_objects.usables.string_value_object import (
+	StringValueObject,
+)
+from test.{{ template_domain_import }}.value_objects.string_primitives_mother import (
+	StringPrimitivesMother,
+)
+
+
+@pytest.mark.unit
+class TestStringValueObject:
+	{% if dependencies | has_dependency("expects") %}
+	def test_should_create_string_value_object(self) -> None:
+		value = StringPrimitivesMother.any()
+
+		string = StringValueObject(value)
+
+		expect(string.value).to(equal(value))
+
+	def test_should_raise_error_when_value_is_none(self) -> None:
+		expect(lambda: StringValueObject(None)).to(raise_error(RequiredValueError))
+
+	def test_should_raise_error_when_value_is_not_string(self) -> None:
+		expect(lambda: StringValueObject(123)).to(raise_error(IncorrectValueTypeError))
+
+	def test_should_compare_equal_with_same_value(self) -> None:
+		common_value = StringPrimitivesMother.any()
+		first_string = StringValueObject(common_value)
+		second_string = StringValueObject(common_value)
+
+		expect(first_string).to(equal(second_string))
+
+	def test_should_not_be_equal_with_different_values(self) -> None:
+		first_string = StringValueObject(StringPrimitivesMother.any())
+		second_string = StringValueObject(StringPrimitivesMother.any())
+
+		expect(first_string).to_not(equal(second_string))
+	{% else %}
+	def test_should_create_string_value_object(self) -> None:
+		value = StringPrimitivesMother.any()
+
+		string = StringValueObject(value)
+
+		assert string.value == value
+
+	def test_should_raise_error_when_value_is_none(self) -> None:
+		with pytest.raises(RequiredValueError):
+			StringValueObject(None)
+
+	def test_should_raise_error_when_value_is_not_string(self) -> None:
+		with pytest.raises(IncorrectValueTypeError):
+			StringValueObject(123)
+
+	def test_should_compare_equal_with_same_value(self) -> None:
+		common_value = StringPrimitivesMother.any()
+		first_string = StringValueObject(common_value)
+		second_string = StringValueObject(common_value)
+
+		assert first_string == second_string
+
+	def test_should_not_be_equal_with_different_values(self) -> None:
+		first_string = StringValueObject(StringPrimitivesMother.any())
+		second_string = StringValueObject(StringPrimitivesMother.any())
+
+		assert first_string != second_string
+	{% endif %}

instant_python-0.9.2/instant_python/templates/boilerplate/value_object/test_uuid_value_object.py

@@ -0,0 +1,88 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template.name) %}
+import pytest
+{% if dependencies | has_dependency("expects") %}
+from expects import expect, equal, raise_error
+{% endif %}
+
+from {{ general.source_name }}.{{ template_domain_import }}.errors.incorrect_value_type_error import (
+	IncorrectValueTypeError,
+)
+from {{ general.source_name }}.{{ template_domain_import }}.errors.invalid_id_format_error import (
+	InvalidIdFormatError,
+)
+from {{ general.source_name }}.{{ template_domain_import }}.errors.required_value_error import RequiredValueError
+from {{ general.source_name }}.{{ template_domain_import }}.value_objects.usables.uuid import (
+	Uuid,
+)
+from test.{{ template_domain_import }}.value_objects.uuid_primitives_mother import (
+	UuidPrimitivesMother,
+)
+
+
+@pytest.mark.unit
+class TestUuidValueObject:
+	{% if dependencies | has_dependency("expects") %}
+	def test_should_create_uuid_value_object(self) -> None:
+		value = UuidPrimitivesMother.any()
+
+		uuid = Uuid(value)
+
+		expect(uuid.value).to(equal(value))
+
+	def test_should_raise_error_when_value_is_none(self) -> None:
+		expect(lambda: Uuid(None)).to(raise_error(RequiredValueError))
+
+	def test_should_raise_error_when_value_is_not_string(self) -> None:
+		expect(lambda: Uuid(123)).to(raise_error(IncorrectValueTypeError))
+
+	def test_should_raise_error_when_value_is_not_valid_uuid(self) -> None:
+		invalid_uuid = UuidPrimitivesMother.invalid()
+		expect(lambda: Uuid(invalid_uuid)).to(raise_error(InvalidIdFormatError))
+
+	def test_should_compare_equal_with_same_value(self) -> None:
+		common_value = UuidPrimitivesMother.any()
+		first_uuid = Uuid(common_value)
+		second_uuid = Uuid(common_value)
+
+		expect(first_uuid).to(equal(second_uuid))
+
+	def test_should_not_be_equal_with_different_values(self) -> None:
+		first_uuid = Uuid(UuidPrimitivesMother.any())
+		second_uuid = Uuid(UuidPrimitivesMother.any())
+
+		expect(first_uuid).to_not(equal(second_uuid))
+
+	{% else %}
+	def test_should_create_uuid_value_object(self) -> None:
+		value = UuidPrimitivesMother.any()
+
+		uuid = Uuid(value)
+
+		assert uuid.value == value
+
+	def test_should_raise_error_when_value_is_none(self) -> None:
+		with pytest.raises(RequiredValueError):
+			Uuid(None)
+
+	def test_should_raise_error_when_value_is_not_string(self) -> None:
+		with pytest.raises(IncorrectValueTypeError):
+			Uuid(123)
+
+	def test_should_raise_error_when_value_is_not_valid_uuid(self) -> None:
+		invalid_uuid = UuidPrimitivesMother.invalid()
+		with pytest.raises(InvalidIdFormatError):
+			Uuid(invalid_uuid)
+
+	def test_should_compare_equal_with_same_value(self) -> None:
+		common_value = UuidPrimitivesMother.any()
+		first_uuid = Uuid(common_value)
+		second_uuid = Uuid(common_value)
+
+		assert first_uuid == second_uuid
+
+	def test_should_not_be_equal_with_different_values(self) -> None:
+		first_uuid = Uuid(UuidPrimitivesMother.any())
+		second_uuid = Uuid(UuidPrimitivesMother.any())
+
+		assert first_uuid != second_uuid
+	{% endif %}

instant_python-0.9.2/instant_python/templates/boilerplate/value_object/uuid_primitives_mother.py

@@ -0,0 +1,12 @@
+{% set template_domain_import = "shared.domain"|compute_base_path(template.name) %}
+from test.{{ template_domain_import }}.random_generator import RandomGenerator
+
+
+class UuidPrimitivesMother:
+	@staticmethod
+	def any() -> str:
+		return RandomGenerator.uuid()
+
+	@staticmethod
+	def invalid() -> str:
+		return "00000000-0000-0000-0000"

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/boilerplate/value_object/value_object.py

@@ -42,6 +42,10 @@ class ValueObject[T](ABC):
 	def __str__(self) -> str:
 		return str(self._value)
 
+	@override
+	def __hash__(self) -> int:
+		return hash(self._value)
+
 	@override
 	def __setattr__(self, name: str, value: T) -> None:
 		"""Prevents modification of the value after initialization."""
@@ -101,6 +105,10 @@ class ValueObject(Generic[T], ABC):
 	@override
 	def __str__(self) -> str:
 		return str(self._value)
+
+	@override
+	def __hash__(self) -> int:
+		return hash(self._value)
 	
 	@override
 	def __setattr__(self, name: str, value: T) -> None:

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/project_structure/clean_architecture/test.yml.j2

@@ -3,19 +3,24 @@
   type: directory
   python: True
   children:
-    - name: unit
+    - name: domain
       type: directory
       python: True
-      {% if "event_bus" in template.built_in_features %}
+      {% if ["value_objects", "event_bus"] | is_in(template.built_in_features) %}
       children:
+      {% if "value_objects" in template.built_in_features %}
+        {{ macros.include_and_indent("project_structure/test_value_objects.yml.j2", 8) }}
+      {% endif %}
+      {% if "event_bus" in template.built_in_features %}
         - name: event_bus/mock_event_bus
           type: boilerplate_file
           extension: .py
       {% endif %}
-    - name: integration
+      {% endif %}
+    - name: infrastructure
       type: directory
       python: True
-    - name: acceptance
+    - name: delivery
       type: directory
       python: True
     - name: random_generator

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/project_structure/domain_driven_design/test.yml.j2

@@ -14,6 +14,9 @@
             - name: random_generator
               type: boilerplate_file
               extension: .py
+            {% if "value_objects" in template.built_in_features %}
+            {{ macros.include_and_indent("project_structure/test_value_objects.yml.j2", 12) }}
+            {% endif %}
         {% if "event_bus" in template.built_in_features %}
         - name: infra
           type: directory

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/project_structure/makefile.yml.j2

@@ -10,10 +10,10 @@
     - name: scripts/remove_dependency
       type: boilerplate_file
       extension: .py
+    {% if "precommit_hook" not in template.built_in_features %}
     - name: scripts/local_setup
       type: boilerplate_file
       extension: .py
-    {% if "precommit_hook" not in template.built_in_features %}
     - name: hooks
       type: directory
       children:

{instant_python-0.9.1 → instant_python-0.9.2}/instant_python/templates/project_structure/standard_project/test.yml.j2

@@ -1,3 +1,4 @@
+{% import "project_structure/macros.j2" as macros with context %}
 - name: test
   type: directory
   python: True
@@ -5,6 +6,9 @@
     - name: random_generator
       type: boilerplate_file
       extension: .py
+    {% if "value_objects" in template.built_in_features %}
+    {{ macros.include_and_indent("project_structure/test_value_objects.yml.j2", 4) }}
+    {% endif %}
     {% if "event_bus" in template.built_in_features %}
     - name: event
       type: directory

instant_python-0.9.2/instant_python/templates/project_structure/test_value_objects.yml.j2

@@ -0,0 +1,26 @@
+- name: value_objects
+  type: directory
+  python: True
+  children:
+    - name: value_object/int_primitives_mother
+      type: boilerplate_file
+      extension: .py
+    - name: value_object/string_primitives_mother
+      type: boilerplate_file
+      extension: .py
+    - name: value_object/uuid_primitives_mother
+      type: boilerplate_file
+      extension: .py
+    - name: usables
+      type: directory
+      python: True
+      children:
+        - name: value_object/test_int_value_object
+          type: boilerplate_file
+          extension: .py
+        - name: value_object/test_string_value_object
+          type: boilerplate_file
+          extension: .py
+        - name: value_object/test_uuid_value_object
+          type: boilerplate_file
+          extension: .py

{instant_python-0.9.1 → instant_python-0.9.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "instant-python"
-version = "0.9.1"
+version = "0.9.2"
 description = "Instant boilerplate generation for Python projects"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -113,11 +113,7 @@ parse_squash_commits = false
 ignore_merge_commits = true
 
 [tool.semantic_release.changelog]
+changelog_file = "CHANGELOG.md"
 exclude_commit_patterns = ['''^Merge pull request #''', '''^Merge branch ''']
 mode = "update"
-template_dir = "docs/changelog"
-
-[tool.semantic_release.changelog.default_templates]
-changelog_file = "CHANGELOG.md"
-output_format = "md"
-mask_initial_release = false
+template_dir = "docs/changelog"

{instant_python-0.9.1 → instant_python-0.9.2}/uv.lock

@@ -531,7 +531,7 @@ wheels = [
 
 [[package]]
 name = "instant-python"
-version = "0.9.1"
+version = "0.9.2"
 source = { editable = "." }
 dependencies = [
     { name = "jinja2" },

instant_python-0.9.1/instant_python/templates/boilerplate/random_generator.py

@@ -1,9 +0,0 @@
-from faker import Faker
-
-
-class RandomGenerator:
-	faker = Faker()
-
-	@classmethod
-	def uuid(cls) -> str:
-	    return cls.faker.uuid4()