wexample-filestate-python 0.0.12__tar.gz → 0.0.13__tar.gz

wexample_filestate_python-0.0.13/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.2
+Name: wexample-filestate-python
+Version: 0.0.13
+Summary: Helpers for Python.
+Author-email: weeger <contact@wexample.com>
+License: MIT
+Project-URL: homepage, https://github.com/wexample/python-filestate-python
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: pip-tools
+Requires-Dist: pydantic
+Requires-Dist: pytest
+Requires-Dist: python-dotenv
+Requires-Dist: wexample-app==0.0.18
+Requires-Dist: wexample-filestate-git==0.0.13
+Requires-Dist: wexample-filestate==0.0.21
+
+# Filestate Python
+
+Helpers for Python.
+
+Version: 0.0.13
+
+## Requirements
+
+- Python >=3.6
+
+## Dependencies
+
+- pip-tools
+- pydantic
+- pytest
+- python-dotenv
+- wexample-app==0.0.18
+- wexample-filestate-git==0.0.13
+- wexample-filestate==0.0.21
+
+## Installation
+
+```bash
+pip install wexample-filestate-python
+```
+
+## Links
+
+- Homepage: https://github.com/wexample/python-filestate-python
+
+## License
+
+MIT
+## Credits
+
+This package has been developed by [Wexample](https://wexample.com), a collection of tools and utilities to streamline development workflows.
+
+Visit [wexample.com](https://wexample.com) to discover more tools and resources for efficient development.

wexample_filestate_python-0.0.13/README.md

@@ -0,0 +1,38 @@
+# Filestate Python
+
+Helpers for Python.
+
+Version: 0.0.13
+
+## Requirements
+
+- Python >=3.6
+
+## Dependencies
+
+- pip-tools
+- pydantic
+- pytest
+- python-dotenv
+- wexample-app==0.0.18
+- wexample-filestate-git==0.0.13
+- wexample-filestate==0.0.21
+
+## Installation
+
+```bash
+pip install wexample-filestate-python
+```
+
+## Links
+
+- Homepage: https://github.com/wexample/python-filestate-python
+
+## License
+
+MIT
+## Credits
+
+This package has been developed by [Wexample](https://wexample.com), a collection of tools and utilities to streamline development workflows.
+
+Visit [wexample.com](https://wexample.com) to discover more tools and resources for efficient development.

{wexample_filestate_python-0.0.12 → wexample_filestate_python-0.0.13}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wexample-filestate-python"
-version = "0.0.12"
+version = "0.0.13"
 description = "Helpers for Python."
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -23,9 +23,9 @@ dependencies = [
     "pydantic",
     "pytest",
     "python-dotenv",
-    "wexample-app==0.0.17",
-    "wexample-filestate-git==0.0.12",
-    "wexample-filestate==0.0.20",
+    "wexample-app==0.0.18",
+    "wexample-filestate-git==0.0.13",
+    "wexample-filestate==0.0.21",
 ]
 
 [project.readme]

wexample_filestate_python-0.0.13/wexample_filestate_python/config_value/python_package_readme_config_value.py

@@ -0,0 +1,82 @@
+from typing import Optional, List
+import os
+
+from wexample_filestate.config_value.readme_content_config_value import ReadmeContentConfigValue
+from wexample_filestate_python.workdir.python_package_workdir import PythonPackageWorkdir
+from wexample_helpers.helpers.string import string_remove_prefix
+
+
+class PythonPackageReadmeContentConfigValue(ReadmeContentConfigValue):
+    workdir: PythonPackageWorkdir
+    vendor: Optional[str]
+
+    def _get_doc_path(self, section: str) -> str:
+        """
+        Returns the path to a documentation section file
+        """
+        return os.path.join(self.workdir.get_path(), '.wex', 'doc', 'readme', f'{section}.md')
+
+    def _add_section_if_exists(self, section: str) -> str:
+        """
+        Returns section content if the documentation file exists
+        """
+        doc_path = self._get_doc_path(section)
+
+        if os.path.exists(doc_path):
+            with open(doc_path, 'r') as file:
+                content = file.read()
+                return f'## {section.title()}\n\n{content}\n\n'
+
+        return ''
+
+    def get_templates(self) -> Optional[List[str]]:
+        project_info = self.workdir.get_project_info()
+        project = project_info.get('project', {})
+
+        # Extract information
+        description = project.get('description', '')
+        python_version = project.get('requires-python', '')
+        dependencies = project.get('dependencies', [])
+        homepage = project.get('urls', {}).get('homepage', '')
+        license_info = project.get('license', {}).get('text', '')
+        version = project.get('version', '')
+
+        # Format dependencies list
+        deps_list = '\n'.join([f'- {dep}' for dep in dependencies])
+
+        return [
+            f'# {self.build_package_name()}\n\n'
+            f'{description}\n\n'
+            f'Version: {version}\n\n'
+            f'{self._add_section_if_exists("features")}'
+            '## Requirements\n\n'
+            f'- Python {python_version}\n\n'
+            '## Dependencies\n\n'
+            f'{deps_list}\n\n'
+            '## Installation\n\n'
+            '```bash\n'
+            f'pip install {project.get("name", "")}\n'
+            '```\n\n'
+            f'{self._add_section_if_exists("usage")}'
+            '## Links\n\n'
+            f'- Homepage: {homepage}\n\n'
+            '## License\n\n'
+            f'{license_info}'
+        ]
+
+    def build_package_name(self) -> str:
+        project_info = self.workdir.get_project_info()
+
+        # Get project name from pyproject.toml
+        project_name = project_info.get('project', {}).get('name', '')
+
+        # Remove vendor prefix if vendor is provided
+        if self.vendor:
+            vendor_prefix = f"{self.vendor.lower()}-"
+            project_name = string_remove_prefix(project_name, vendor_prefix)
+
+        # Convert remaining kebab-case to Title Case
+        # e.g. "vendor-package-name" -> "Package Name"
+        package_name = ' '.join(word.title() for word in project_name.split('-'))
+
+        return package_name

{wexample_filestate_python-0.0.12 → wexample_filestate_python-0.0.13}/wexample_filestate_python/workdir/python_package_workdir.py

@@ -1,11 +1,45 @@
 from typing import Optional
 
+
 from wexample_config.const.types import DictConfig
 from wexample_filestate_python.workdir.python_workdir import PythonWorkdir
 from wexample_helpers.helpers.array import array_dict_get_by
 
 
+
 class PythonPackageWorkdir(PythonWorkdir):
+    _project_info_cache = None
+
+    def get_project_info(self, force: bool = False) -> dict:
+        """
+        Fetch the data from the pyproject.toml file.
+
+        :param force: If True, forces reloading the data even if it was previously cached.
+        :return: A dictionary representing the contents of pyproject.toml.
+        """
+        # Return cached data if available and force is False
+        if not force and self._project_info_cache is not None:
+            return self._project_info_cache
+
+        from wexample_helpers.helpers.file import file_read
+        import tomli
+
+
+        project_path = self.get_resolved()
+        pyproject_file = f"{project_path}pyproject.toml"
+
+        # Read the pyproject.toml file
+        try:
+            pyproject_content = file_read(pyproject_file)
+            pyproject_data = tomli.loads(pyproject_content)
+            # Store in cache
+            self._project_info_cache = pyproject_data
+        except FileNotFoundError:
+            self.io.error(f"pyproject.toml file not found at {pyproject_file}", fatal=True)
+            return {}
+
+        return pyproject_data
+
     def prepare_value(self, config: Optional[DictConfig] = None) -> DictConfig:
         from wexample_filestate.const.disk import DiskItemType
         from wexample_filestate_python.const.name_pattern import NAME_PATTERN_PYTHON_NOT_PYCACHE

wexample_filestate_python-0.0.13/wexample_filestate_python.egg-info/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.2
+Name: wexample-filestate-python
+Version: 0.0.13
+Summary: Helpers for Python.
+Author-email: weeger <contact@wexample.com>
+License: MIT
+Project-URL: homepage, https://github.com/wexample/python-filestate-python
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: pip-tools
+Requires-Dist: pydantic
+Requires-Dist: pytest
+Requires-Dist: python-dotenv
+Requires-Dist: wexample-app==0.0.18
+Requires-Dist: wexample-filestate-git==0.0.13
+Requires-Dist: wexample-filestate==0.0.21
+
+# Filestate Python
+
+Helpers for Python.
+
+Version: 0.0.13
+
+## Requirements
+
+- Python >=3.6
+
+## Dependencies
+
+- pip-tools
+- pydantic
+- pytest
+- python-dotenv
+- wexample-app==0.0.18
+- wexample-filestate-git==0.0.13
+- wexample-filestate==0.0.21
+
+## Installation
+
+```bash
+pip install wexample-filestate-python
+```
+
+## Links
+
+- Homepage: https://github.com/wexample/python-filestate-python
+
+## License
+
+MIT
+## Credits
+
+This package has been developed by [Wexample](https://wexample.com), a collection of tools and utilities to streamline development workflows.
+
+Visit [wexample.com](https://wexample.com) to discover more tools and resources for efficient development.

{wexample_filestate_python-0.0.12 → wexample_filestate_python-0.0.13}/wexample_filestate_python.egg-info/SOURCES.txt

@@ -6,6 +6,8 @@ wexample_filestate_python.egg-info/SOURCES.txt
 wexample_filestate_python.egg-info/dependency_links.txt
 wexample_filestate_python.egg-info/requires.txt
 wexample_filestate_python.egg-info/top_level.txt
+wexample_filestate_python/config_value/__init__.py
+wexample_filestate_python/config_value/python_package_readme_config_value.py
 wexample_filestate_python/const/__init__.py
 wexample_filestate_python/const/name_pattern.py
 wexample_filestate_python/helpers/__init__.py

wexample_filestate_python-0.0.13/wexample_filestate_python.egg-info/requires.txt

@@ -0,0 +1,7 @@
+pip-tools
+pydantic
+pytest
+python-dotenv
+wexample-app==0.0.18
+wexample-filestate-git==0.0.13
+wexample-filestate==0.0.21

wexample_filestate_python-0.0.12/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.2
-Name: wexample-filestate-python
-Version: 0.0.12
-Summary: Helpers for Python.
-Author-email: weeger <contact@wexample.com>
-License: MIT
-Project-URL: homepage, https://github.com/wexample/python-filestate-python
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: pip-tools
-Requires-Dist: pydantic
-Requires-Dist: pytest
-Requires-Dist: python-dotenv
-Requires-Dist: wexample-app==0.0.17
-Requires-Dist: wexample-filestate-git==0.0.12
-Requires-Dist: wexample-filestate==0.0.20

wexample_filestate_python-0.0.12/wexample_filestate_python.egg-info/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.2
-Name: wexample-filestate-python
-Version: 0.0.12
-Summary: Helpers for Python.
-Author-email: weeger <contact@wexample.com>
-License: MIT
-Project-URL: homepage, https://github.com/wexample/python-filestate-python
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: pip-tools
-Requires-Dist: pydantic
-Requires-Dist: pytest
-Requires-Dist: python-dotenv
-Requires-Dist: wexample-app==0.0.17
-Requires-Dist: wexample-filestate-git==0.0.12
-Requires-Dist: wexample-filestate==0.0.20

wexample_filestate_python-0.0.12/wexample_filestate_python.egg-info/requires.txt

@@ -1,7 +0,0 @@
-pip-tools
-pydantic
-pytest
-python-dotenv
-wexample-app==0.0.17
-wexample-filestate-git==0.0.12
-wexample-filestate==0.0.20