wexample-filestate 0.0.2__tar.gz

wexample-filestate-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wexample-filestate-0.0.2/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: wexample-filestate
+Version: 0.0.2
+Summary: A tool for managing file states, with configuration files in YAML.
+Home-page: https://github.com/wexample/python-filestate
+Author: weeger
+Author-email: contact@wexample.com
+License: UNKNOWN
+Platform: UNKNOWN
+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
+License-File: LICENSE
+
+# filestate
+
+`filestate` is a Python package that allows you to manage the state of files and directories using YAML configuration files.
+
+## Features
+
+- **Apply and Modify Permissions and Ownership**: Manage file and directory permissions and ownership individually or recursively.
+- **Create, Modify, and Delete Directories**: Use patterns and regex to create, modify, and delete directories and subdirectories (e.g., ensure each `Entity/MyEntity.php` file has a corresponding `Repository/MyEntityRepository.php`).
+- **Create Files Using Templates and Placeholders**: Generate files from templates with dynamic placeholders.
+
+## Installation
+
+Install `filestate` with pip:
+
+pip install wexample-filestate
+
+## Usage
+
+### Configuration File Example
+
+```yaml
+# example.yaml
+files:
+  - path: /path/to/file
+    owner: user
+    group: group
+    mode: '0644'
+directories:
+  - path: /path/to/directory
+    recursive: true
+    mode: '0755'
+    create: true
+templates:
+  - path: /path/to/output/file
+    template: /path/to/template/file
+    placeholders:
+      placeholder1: value1
+      placeholder2: value2
+```
+
+## Usage
+
+Here's how you can use filestate in your Python code:
+
+```
+from filestate import FileStateManager
+
+# Initialize the state manager with the root directory
+state_manager = FileStateManager('root/directory/')
+
+# Configure the state manager from a YAML configuration file
+state_manager.configure_from_file('configuration.yaml')
+
+# Perform a dry run to see what changes would be made
+result = state_manager.dry_run()
+result.print()
+
+# Check if the configuration can be successfully applied
+if state_manager.succeed():
+    # Apply the configuration
+    state_manager.apply()
+else:
+    print("Configuration could not be applied successfully.")
+
+```
+
+### Applying and Modifying Permissions
+
+```
+state_manager = FileStateManager('/var/www/')
+state_manager.configure({
+    'files': [
+        {'path': '/var/www/index.html', 'owner': 'www-data', 'group': 'www-data', 'mode': '0644'},
+        {'path': '/var/www/css/', 'recursive': True, 'owner': 'www-data', 'group': 'www-data', 'mode': '0755'}
+    ]
+})
+state_manager.apply()
+```
+
+### Applying and Modifying Permissions
+
+```
+state_manager = FileStateManager('/project/')
+state_manager.configure({
+    'directories': [
+        {'path': '/project/src/Entity/', 'create': True},
+        {'path': '/project/src/Repository/', 'create': True, 'pattern': 'Entity/*Entity.php', 'target': 'Repository/*Repository.php'}
+    ]
+})
+state_manager.apply()
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+

wexample-filestate-0.0.2/README.md

@@ -0,0 +1,95 @@
+# filestate
+
+`filestate` is a Python package that allows you to manage the state of files and directories using YAML configuration files.
+
+## Features
+
+- **Apply and Modify Permissions and Ownership**: Manage file and directory permissions and ownership individually or recursively.
+- **Create, Modify, and Delete Directories**: Use patterns and regex to create, modify, and delete directories and subdirectories (e.g., ensure each `Entity/MyEntity.php` file has a corresponding `Repository/MyEntityRepository.php`).
+- **Create Files Using Templates and Placeholders**: Generate files from templates with dynamic placeholders.
+
+## Installation
+
+Install `filestate` with pip:
+
+pip install wexample-filestate
+
+## Usage
+
+### Configuration File Example
+
+```yaml
+# example.yaml
+files:
+  - path: /path/to/file
+    owner: user
+    group: group
+    mode: '0644'
+directories:
+  - path: /path/to/directory
+    recursive: true
+    mode: '0755'
+    create: true
+templates:
+  - path: /path/to/output/file
+    template: /path/to/template/file
+    placeholders:
+      placeholder1: value1
+      placeholder2: value2
+```
+
+## Usage
+
+Here's how you can use filestate in your Python code:
+
+```
+from filestate import FileStateManager
+
+# Initialize the state manager with the root directory
+state_manager = FileStateManager('root/directory/')
+
+# Configure the state manager from a YAML configuration file
+state_manager.configure_from_file('configuration.yaml')
+
+# Perform a dry run to see what changes would be made
+result = state_manager.dry_run()
+result.print()
+
+# Check if the configuration can be successfully applied
+if state_manager.succeed():
+    # Apply the configuration
+    state_manager.apply()
+else:
+    print("Configuration could not be applied successfully.")
+
+```
+
+### Applying and Modifying Permissions
+
+```
+state_manager = FileStateManager('/var/www/')
+state_manager.configure({
+    'files': [
+        {'path': '/var/www/index.html', 'owner': 'www-data', 'group': 'www-data', 'mode': '0644'},
+        {'path': '/var/www/css/', 'recursive': True, 'owner': 'www-data', 'group': 'www-data', 'mode': '0755'}
+    ]
+})
+state_manager.apply()
+```
+
+### Applying and Modifying Permissions
+
+```
+state_manager = FileStateManager('/project/')
+state_manager.configure({
+    'directories': [
+        {'path': '/project/src/Entity/', 'create': True},
+        {'path': '/project/src/Repository/', 'create': True, 'pattern': 'Entity/*Entity.php', 'target': 'Repository/*Repository.php'}
+    ]
+})
+state_manager.apply()
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

wexample-filestate-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wexample-filestate-0.0.2/setup.py

@@ -0,0 +1,25 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='wexample-filestate',
+    version=open('version.txt').read(),
+    author='weeger',
+    author_email='contact@wexample.com',
+    description='A tool for managing file states, with configuration files in YAML.',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    url='https://github.com/wexample/python-filestate',
+    packages=find_packages(),
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+    ],
+    install_requires=[
+        'pydantic',
+        'pyyaml',
+        'wexample-helpers',
+        'wexample-helpers-yaml'
+    ],
+    python_requires='>=3.6',
+)

wexample-filestate-0.0.2/wexample_filestate.egg-info/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.1
+Name: wexample-filestate
+Version: 0.0.2
+Summary: A tool for managing file states, with configuration files in YAML.
+Home-page: https://github.com/wexample/python-filestate
+Author: weeger
+Author-email: contact@wexample.com
+License: UNKNOWN
+Platform: UNKNOWN
+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
+License-File: LICENSE
+
+# filestate
+
+`filestate` is a Python package that allows you to manage the state of files and directories using YAML configuration files.
+
+## Features
+
+- **Apply and Modify Permissions and Ownership**: Manage file and directory permissions and ownership individually or recursively.
+- **Create, Modify, and Delete Directories**: Use patterns and regex to create, modify, and delete directories and subdirectories (e.g., ensure each `Entity/MyEntity.php` file has a corresponding `Repository/MyEntityRepository.php`).
+- **Create Files Using Templates and Placeholders**: Generate files from templates with dynamic placeholders.
+
+## Installation
+
+Install `filestate` with pip:
+
+pip install wexample-filestate
+
+## Usage
+
+### Configuration File Example
+
+```yaml
+# example.yaml
+files:
+  - path: /path/to/file
+    owner: user
+    group: group
+    mode: '0644'
+directories:
+  - path: /path/to/directory
+    recursive: true
+    mode: '0755'
+    create: true
+templates:
+  - path: /path/to/output/file
+    template: /path/to/template/file
+    placeholders:
+      placeholder1: value1
+      placeholder2: value2
+```
+
+## Usage
+
+Here's how you can use filestate in your Python code:
+
+```
+from filestate import FileStateManager
+
+# Initialize the state manager with the root directory
+state_manager = FileStateManager('root/directory/')
+
+# Configure the state manager from a YAML configuration file
+state_manager.configure_from_file('configuration.yaml')
+
+# Perform a dry run to see what changes would be made
+result = state_manager.dry_run()
+result.print()
+
+# Check if the configuration can be successfully applied
+if state_manager.succeed():
+    # Apply the configuration
+    state_manager.apply()
+else:
+    print("Configuration could not be applied successfully.")
+
+```
+
+### Applying and Modifying Permissions
+
+```
+state_manager = FileStateManager('/var/www/')
+state_manager.configure({
+    'files': [
+        {'path': '/var/www/index.html', 'owner': 'www-data', 'group': 'www-data', 'mode': '0644'},
+        {'path': '/var/www/css/', 'recursive': True, 'owner': 'www-data', 'group': 'www-data', 'mode': '0755'}
+    ]
+})
+state_manager.apply()
+```
+
+### Applying and Modifying Permissions
+
+```
+state_manager = FileStateManager('/project/')
+state_manager.configure({
+    'directories': [
+        {'path': '/project/src/Entity/', 'create': True},
+        {'path': '/project/src/Repository/', 'create': True, 'pattern': 'Entity/*Entity.php', 'target': 'Repository/*Repository.php'}
+    ]
+})
+state_manager.apply()
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+

wexample-filestate-0.0.2/wexample_filestate.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+LICENSE
+README.md
+setup.py
+wexample_filestate.egg-info/PKG-INFO
+wexample_filestate.egg-info/SOURCES.txt
+wexample_filestate.egg-info/dependency_links.txt
+wexample_filestate.egg-info/requires.txt
+wexample_filestate.egg-info/top_level.txt

wexample-filestate-0.0.2/wexample_filestate.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

wexample-filestate-0.0.2/wexample_filestate.egg-info/requires.txt

@@ -0,0 +1,4 @@
+pydantic
+pyyaml
+wexample-helpers
+wexample-helpers-yaml

wexample-filestate-0.0.2/wexample_filestate.egg-info/top_level.txt

@@ -0,0 +1 @@
+