scriptman

Name	scriptman JSON
Version	0.0.0.71 JSON
	download
home_page	None
Summary	ScriptMan is a versatile Python package that simplifies script management tasks, offering a wide range of utilities for various scripting needs. Whether you're dealing with data, databases, command-line interfaces, web automation, or just aiming for better script organization, ScriptMan has you covered. With features like cleanup handling, database interaction, file management, logging, and more, ScriptMan is your go-to tool for efficient and well-organized scripting in Python.
upload_time	2024-06-24 07:13:32
maintainer	None
docs_url	None
author	Nelson Ombuya
requires_python	None
license	None
keywords	python scripts etl selenium
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # ScriptMan - A Python Package for Script Management

ScriptMan is a Python package that provides a comprehensive set of tools and utilities for managing Python scripts. Whether you're working with data, databases, command-line interfaces, web automation, or just need better script organization, ScriptMan has you covered.

## Installation

You can install ScriptMan using pip:

```bash
pip install scriptman
```

## Usage

```python
import scriptman

# Example: Run a script
scriptman.ScriptsHandler().run_script('my_script.py')
```

## Features

### CleanUpHandler

- Provides cleanup functionalities for scripts.

### CLIHandler

- Handles command-line interface interactions.

### CSVHandler

- Offers utilities for working with CSV files.

### DatabaseHandler

- Provides database interaction capabilities.

### DirectoryHandler

- Manages directories and file operations.

### ETLHandler

- Offers tools for Extract, Transform, Load (ETL) processes.

### LogHandler

- Handles logging with different log levels.

### LogLevel

- Enum for different log levels.

### ScriptsHandler

- Manages the execution of scripts.

### SeleniumHandler

- Provides tools for web automation using Selenium.

### SeleniumInteraction

- Enum for Selenium-based interactions.

### Settings

- Accesses and manages package settings.

## Initialization

To set up ScriptMan for your project, you should call the following method from the `Settings` class upon start:

```python
from scriptman import Settings

Settings.init(
    root_dir='your_project_directory',
    logging=True,  # Enable logging (default is True)
    debugging=False,  # Enable debugging mode (default is False)
)
```

Calling this method will set up ScriptMan's app files in your project directory under the app folder. It will create various folders:

- `downloads`: Used for downloads (e.g., Downloads made by Selenium).
- `helpers`: Used for any extra modules you want to reuse in your code (e.g., API Classes).
- `scripts`: Where your scripts should reside.
- `Logs`: Where the log files will be saved.

## Documentation

For detailed documentation and examples, please refer to the [package documentation](https://github.com/nelsonombuya/scriptman/blob/main/docs/README.md).

## Example

```python
# Import ScriptMan modules
import scriptman

# Create a ScriptsHandler instance
script_handler = scriptman.ScriptsHandler()

# Run a Python script
script_handler.run_script('my_script.py')
```

## Contributing

We welcome contributions! Please feel free to submit issues and pull requests to help improve this package.

## License

This package is distributed under the [MIT License](https://opensource.org/licenses/MIT).


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "scriptman",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "python, scripts, etl, selenium",
    "author": "Nelson Ombuya",
    "author_email": "nelson.ombuya@zohomail.com",
    "download_url": "https://files.pythonhosted.org/packages/0b/d4/8a955f87b139e148c771b1f140b96b4760e074fa20512f81063e68eba7fe/scriptman-0.0.0.71.tar.gz",
    "platform": null,
    "description": "# ScriptMan - A Python Package for Script Management\r\n\r\nScriptMan is a Python package that provides a comprehensive set of tools and utilities for managing Python scripts. Whether you're working with data, databases, command-line interfaces, web automation, or just need better script organization, ScriptMan has you covered.\r\n\r\n## Installation\r\n\r\nYou can install ScriptMan using pip:\r\n\r\n```bash\r\npip install scriptman\r\n```\r\n\r\n## Usage\r\n\r\n```python\r\nimport scriptman\r\n\r\n# Example: Run a script\r\nscriptman.ScriptsHandler().run_script('my_script.py')\r\n```\r\n\r\n## Features\r\n\r\n### CleanUpHandler\r\n\r\n- Provides cleanup functionalities for scripts.\r\n\r\n### CLIHandler\r\n\r\n- Handles command-line interface interactions.\r\n\r\n### CSVHandler\r\n\r\n- Offers utilities for working with CSV files.\r\n\r\n### DatabaseHandler\r\n\r\n- Provides database interaction capabilities.\r\n\r\n### DirectoryHandler\r\n\r\n- Manages directories and file operations.\r\n\r\n### ETLHandler\r\n\r\n- Offers tools for Extract, Transform, Load (ETL) processes.\r\n\r\n### LogHandler\r\n\r\n- Handles logging with different log levels.\r\n\r\n### LogLevel\r\n\r\n- Enum for different log levels.\r\n\r\n### ScriptsHandler\r\n\r\n- Manages the execution of scripts.\r\n\r\n### SeleniumHandler\r\n\r\n- Provides tools for web automation using Selenium.\r\n\r\n### SeleniumInteraction\r\n\r\n- Enum for Selenium-based interactions.\r\n\r\n### Settings\r\n\r\n- Accesses and manages package settings.\r\n\r\n## Initialization\r\n\r\nTo set up ScriptMan for your project, you should call the following method from the `Settings` class upon start:\r\n\r\n```python\r\nfrom scriptman import Settings\r\n\r\nSettings.init(\r\n    root_dir='your_project_directory',\r\n    logging=True,  # Enable logging (default is True)\r\n    debugging=False,  # Enable debugging mode (default is False)\r\n)\r\n```\r\n\r\nCalling this method will set up ScriptMan's app files in your project directory under the app folder. It will create various folders:\r\n\r\n- `downloads`: Used for downloads (e.g., Downloads made by Selenium).\r\n- `helpers`: Used for any extra modules you want to reuse in your code (e.g., API Classes).\r\n- `scripts`: Where your scripts should reside.\r\n- `Logs`: Where the log files will be saved.\r\n\r\n## Documentation\r\n\r\nFor detailed documentation and examples, please refer to the [package documentation](https://github.com/nelsonombuya/scriptman/blob/main/docs/README.md).\r\n\r\n## Example\r\n\r\n```python\r\n# Import ScriptMan modules\r\nimport scriptman\r\n\r\n# Create a ScriptsHandler instance\r\nscript_handler = scriptman.ScriptsHandler()\r\n\r\n# Run a Python script\r\nscript_handler.run_script('my_script.py')\r\n```\r\n\r\n## Contributing\r\n\r\nWe welcome contributions! Please feel free to submit issues and pull requests to help improve this package.\r\n\r\n## License\r\n\r\nThis package is distributed under the [MIT License](https://opensource.org/licenses/MIT).\r\n\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "ScriptMan is a versatile Python package that simplifies script  management tasks, offering a wide range of utilities for various scripting needs. Whether you're dealing with data, databases, command-line interfaces, web automation, or just aiming for better script organization, ScriptMan has you covered. With features like cleanup handling, database interaction, file management, logging, and more, ScriptMan is your go-to tool for efficient and well-organized scripting in Python.",
    "version": "0.0.0.71",
    "project_urls": null,
    "split_keywords": [
        "python",
        " scripts",
        " etl",
        " selenium"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5933bcd647e8ff0e7df3b79f2e72229ecb514eae8c9d30d9df51c81565f95faa",
                "md5": "704bb9aa978b0de6ba604c9b59c4ba11",
                "sha256": "7ab3255cc5b096cbebf955a74403f3837e0be46e2e8b6ce25d4c76bf16b8d5b9"
            },
            "downloads": -1,
            "filename": "scriptman-0.0.0.71-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "704bb9aa978b0de6ba604c9b59c4ba11",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 44592,
            "upload_time": "2024-06-24T07:13:29",
            "upload_time_iso_8601": "2024-06-24T07:13:29.816643Z",
            "url": "https://files.pythonhosted.org/packages/59/33/bcd647e8ff0e7df3b79f2e72229ecb514eae8c9d30d9df51c81565f95faa/scriptman-0.0.0.71-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0bd48a955f87b139e148c771b1f140b96b4760e074fa20512f81063e68eba7fe",
                "md5": "42d475b53c363d5fc51e16b9e28deeaf",
                "sha256": "42e07d426d008c43527f8807f4deb10e02d980d0d2ccda20da9ac3043d3e90fe"
            },
            "downloads": -1,
            "filename": "scriptman-0.0.0.71.tar.gz",
            "has_sig": false,
            "md5_digest": "42d475b53c363d5fc51e16b9e28deeaf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 42424,
            "upload_time": "2024-06-24T07:13:32",
            "upload_time_iso_8601": "2024-06-24T07:13:32.109891Z",
            "url": "https://files.pythonhosted.org/packages/0b/d4/8a955f87b139e148c771b1f140b96b4760e074fa20512f81063e68eba7fe/scriptman-0.0.0.71.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-24 07:13:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "scriptman"
}