attix 0.1.0__py3-none-any.whl

attix/__init__.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+"""Top-level package for attix."""
+# Core Library modules
+import logging.config
+from importlib.metadata import version
+
+# Third party modules
+import yaml  # type: ignore
+
+__version__ = version("attix")
+
+LOGGING_CONFIG = """
+version: 1
+disable_existing_loggers: False
+handlers:
+  console:
+    class: logging.StreamHandler
+    level: DEBUG
+    stream: ext://sys.stdout
+    formatter: basic
+  file:
+    class: logging.handlers.RotatingFileHandler
+    level: DEBUG
+    filename: logs/log.txt
+    maxBytes: 1048576    # 1MB
+    backupCount: 3       # keeps log.txt, log.txt.1, log.txt.2, log.txt.3
+    formatter: timestamp
+    encoding: utf-8
+
+formatters:
+  basic:
+    style: "{"
+    format: "{message:s}"
+  timestamp:
+    style: "{"
+    format: "{asctime} - {levelname} - {filename}:{lineno} - {message}"
+
+loggers:
+  init:
+    handlers: [console, file]
+    level: DEBUG
+    propagate: False
+"""
+
+logging.config.dictConfig(yaml.safe_load(LOGGING_CONFIG))
+logger = logging.getLogger("init")

attix/attix.py

@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+"""Example script to demonstrate layout and testing."""
+# Core Library modules
+import sys
+from typing import Any
+
+# Third party modules
+
+# Local modules
+from . import logger
+
+
+
+
+
+
+def handle_exception(exc_type, exc_value, exc_traceback):  # type: ignore
+    if issubclass(exc_type, KeyboardInterrupt):
+        sys.__excepthook__(exc_type, exc_value, exc_traceback)
+        return
+    logger.error("Uncaught exception", exc_info=(exc_type, exc_value, exc_traceback))
+
+sys.excepthook = handle_exception
+
+
+def fizzbuzz(number_range: int) -> list:
+    
+    """Demonstrate one solution to the FizzBuzz problem.
+
+    Args:
+        number_range (int): The maximum number that will be used
+
+    Returns:
+        list: The result will be returned as a list
+
+    Examples:
+        >>> fizzbuzz(20)
+    """
+    result: list[Any] = []
+    for num in range(1, number_range):
+        if num % 15 == 0:
+            result.append("FizzBuzz")
+        elif num % 5 == 0:
+            result.append("Buzz")
+        elif num % 3 == 0:
+            result.append("Fizz")
+        else:
+            result.append(num)
+    logger.debug(f'fizzbuzz result: {result}')
+    return result
+
+
+def fibonacci(number_range: int) -> list:
+    
+    """series of numbers in which each number is the sum of the two that precede it.
+
+    Args:
+        number_range (int): The maximum number that will be used
+
+    Returns:
+        list: The result will be returned as a list
+
+    Examples:
+        >>> fibonacci(20)
+    """
+    
+    result: list = []
+    a, b = 1, 1
+    while True:
+        if a >= number_range:
+            logger.debug(f'fibonacci result: {result}')
+            return result
+        result.append(a)
+        a, b = b, (a + b)
+
+
+def main():    # type: ignore
+    print(fizzbuzz(20))
+    print(fibonacci(20))
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())
+
+
+
+

attix/attix_cli.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+"""Example CLI module using click package."""
+
+
+# Third party modules
+import click
+
+
+@click.group()
+def info() -> None:
+    """Create a container to which other commands can be attached."""
+
+
+@info.command(help="Display Author Name")
+@click.option("-verbose", "--verbose", is_flag=True, help="set the verbosity")
+def author(verbose: str) -> None:
+    """Returns details about the Author."""
+    click.echo("Author name: Stephen R A King")
+    if verbose:
+        click.echo("Author eMail: sking.github@gmail.com")
+
+
+if __name__ == "__main__":
+    raise SystemExit(info())

attix-0.1.0.dist-info/METADATA

@@ -0,0 +1,365 @@
+Metadata-Version: 2.4
+Name: attix
+Version: 0.1.0
+Summary: store filenames of a remote NAS device for searching
+Author-email: Stephen R A King <sking.github@gmail.com>
+Maintainer-email: Stephen R A King <sking.github@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Stephen-RA-King/attix
+Project-URL: Download, https://github.com/Stephen-RA-King/attix/archive/refs/heads/main.zip
+Project-URL: Documentation, https://attix.readthedocs.io/en/latest/
+Project-URL: CI, https://github.com/Stephen-RA-King/attix/actions
+Project-URL: Release Notes, https://github.com/Stephen-RA-King/attix/releases
+Project-URL: Source Code, https://github.com/Stephen-RA-King/attix/
+Project-URL: Bug Tracker, https://github.com/Stephen-RA-King/attix/issues
+Keywords: utility
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: pyyaml
+Dynamic: license-file
+
+# attix
+
+> Short blurb about what your product does.
+
+[![PyPI][pypi-image]][pypi-url]
+[![Downloads][downloads-image]][downloads-url]
+[![Status][status-image]][pypi-url]
+[![Python Version][python-version-image]][pypi-url]
+[![tests][tests-image]][tests-url]
+[![Codecov][codecov-image]][codecov-url]
+[![CodeQl][codeql-image]][codeql-url]
+[![Docker][docker-image]][docker-url]
+[![pre-commit][pre-commit-image]][pre-commit-url]
+[![pre-commit.ci status][pre-commit.ci-image]][pre-commit.ci-url]
+[![readthedocs][readthedocs-image]][readthedocs-url]
+[![CodeFactor][codefactor-image]][codefactor-url]
+[![Codeclimate][codeclimate-image]][codeclimate-url]
+[![Imports: isort][isort-image]][isort-url]
+[![Code style: black][black-image]][black-url]
+[![Checked with mypy][mypy-image]][mypy-url]
+[![security: bandit][bandit-image]][bandit-url]
+[![Commitizen friendly][commitizen-image]][commitizen-url]
+[![Conventional Commits][conventional-commits-image]][conventional-commits-url]
+[![Versioning][versioning-image]][versioning-url]
+[![DeepSource][deepsource-image]][deepsource-url]
+[![license][license-image]][license-url]
+[![Pydough][pydough-image]][pydough-url]
+[![OpenSSFScorecard][openssf-image]][openssf-url]
+
+One to two paragraph statement about your product and what it does.
+
+![](assets/header_dough1.png)
+
+
+# Contents
+
+-   [Demo](#-demo)
+-   [Project rationale](#-project-rationale)
+-   [Quick start](#-quickstart)
+    -   [Prerequisites](#-prerequisites)
+    -   [Installation](#-installation)
+    -   [Basic Usage](#-basic-usage)
+-   [Usage](#-usage)
+-   [Development setup](#-development-setup)
+-   [Configuration](#-configuration)
+-   [Documentation](#-documentation)
+    -   [Read the Docs](https://pynamer.readthedocs.io/en/latest/)
+    -   [API](https://pynamer.readthedocs.io/en/latest/autoapi/pynamer/pynamer/index.html)
+    -   [Wiki](https://github.com/Stephen-RA-King/pynamer/wiki)
+-   [FAQs](#-faqs)
+-   [What's new in version x.x](#-whats-new-in-version-xx)
+-   [Planned future enhancements](#-planned-future-enhancements)
+-   [Package statistics](#-package-statistics)
+-   [License](#-license)
+-   [Meta information](#ℹ-meta)
+
+
+## :eyeglasses: TLDR
+
+A very succinct paragraph summary regarding the package purpose and operation.
+
+
+# :film_projector: Demo
+
+---
+
+Put a demo animated gif here.
+
+
+# :bulb: Project rationale
+
+---
+
+Why I built this project
+
+
+
+
+# :rocket: Quickstart
+
+---
+
+Explain succinctly how to use the repository
+
+## :spiral_notepad: Prerequisites
+
+- A bulleted list of requirements
+
+
+## :floppy_disk: Installation
+
+
+OS X & Linux:
+
+```sh
+pip3 install attix
+```
+
+Windows:
+
+```sh
+pip install attix
+```
+
+## :computer: Basic Usage
+
+A simple example demonstrating that the package is working
+
+
+# :computer: Usage
+
+---
+
+A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
+
+_For more examples and usage, please refer to the [Wiki][wiki]._
+
+# :wrench: Development setup
+
+---
+
+Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
+
+```sh
+pip install --editable attix
+```
+
+# :gear: Configuration
+
+---
+
+Place configuration information here
+
+
+# :lock: Security Considerations
+
+---
+
+Write any security concerns that you may have here.
+e.g. exposure of API keys, passwords, old modules etc.
+
+
+# :books: Documentation
+
+---
+
+[**Read the Docs**](https://attix.readthedocs.io/en/latest/)
+
+- [**Example Usage**](https://attix.readthedocs.io/en/latest/example.html)
+- [**Credits**](https://attix.readthedocs.io/en/latest/example.html)
+- [**Changelog**](https://attix.readthedocs.io/en/latest/changelog.html)
+- [**API Reference**](https://attix.readthedocs.io/en/latest/autoapi/index.html)
+
+
+[**Wiki**](https://github.com/Stephen-RA-King/attix/wiki)
+
+# :dna: Design Considerations
+
+---
+
+A few paragraphs on the design considerations if required.
+
+# :whale: Using Docker
+
+---
+
+## Building the Image from Dockerfile
+
+Start your docker runtime then:
+
+Build the image using ***docker build*** command. e.g.
+
+
+```shell
+$ docker build -t sraking/attix:0.1.0 -t sraking/attix:latest .
+```
+
+Once built, run the image using the ***docker run*** command.  This will create the container. e.g.
+
+```shell
+$ docker run -it sraking/attix:0.1.0 /bin/bash
+```
+
+Optional: The image can now be pushed to the repository using the ***docker push*** command. e.g.
+
+```shell
+$ docker push sraking/attix:0.1.0
+```
+
+## Using the ready built image on dockerhub
+
+Pull the latest image from the repository using the ***docker pull*** command. e.g.
+
+```bash
+~ $ docker pull sraking/attix
+```
+
+Now run the image using the ***docker run*** command.  This will create the container. e.g.
+
+```bash
+~ $ docker run -it sraking/attix /bin/bash
+```
+
+Use the command line as normal in the container.
+
+```bash
+root@4d315992ca28:/app# attix -h
+```
+
+# :warning: Limitations
+
+---
+
+Describe any limitation the application may have (if any).
+
+# :interrobang: Some Quirks
+
+---
+
+The reason I wrote this application in the first place.
+
+
+## :question: FAQs
+
+---
+
+Give examples of frequently asked questions
+
+
+# :newspaper: What's new in version x.x
+
+---
+
+- bulleted list of new features
+
+# :calendar: Planned future enhancements
+
+---
+
+- Feature 1
+- Feature 2
+
+
+# :bar_chart: Package statistics
+
+---
+
+- [**libraries.io**](https://libraries.io/pypi/Stephen-RA-King)
+- [**PyPI Stats**](https://pypistats.org/packages/Stephen-RA-King)
+- [**Pepy**](https://www.pepy.tech/projects/Stephen-RA-King)
+
+
+# :scroll: License
+
+---
+
+Distributed under the MIT license. See [![][license-image]][license-url] for more information.
+
+
+
+# < :information_source: > Meta
+
+---
+
+[![](assets/linkedin.png)](https://www.linkedin.com/in/sr-king)
+[![](assets/github.png)](https://github.com/Stephen-RA-King)
+[![](assets/pypi.png)](https://pypi.org/project/attix)
+[![Docker](assets/docker.png)](https://hub.docker.com/r/sraking/attix)
+[![](assets/www.png)](https://stephen-ra-king.github.io/justpython/)
+[![](assets/email2.png)](mailto:sking.github@gmail.com)
+[![](assets/github.png)](https://github.com/Stephen-RA-King/attix)
+
+
+Author: Stephen R A King ([sking.github@gmail.com](mailto:sking.github@gmail.com))
+
+Created with Cookiecutter template: [![pydough][pydough-image]][pydough-url]
+
+Digital object identifier: [![DOI](https://zenodo.org/badge/xxxxxxxxx.svg)](https://zenodo.org/badge/latestdoi/xxxxxxxxx)
+
+
+<!-- Markdown link & img dfn's -->
+
+[bandit-image]: https://img.shields.io/badge/security-bandit-yellow.svg
+[bandit-url]: https://github.com/PyCQA/bandit
+[black-image]: https://img.shields.io/badge/code%20style-black-000000.svg
+[black-url]: https://github.com/psf/black
+[codeclimate-image]: https://api.codeclimate.com/v1/badges/7fc352185512a1dab75d/maintainability
+[codeclimate-url]: https://codeclimate.com/github/Stephen-RA-King/attix/maintainability
+[codecov-image]: https://codecov.io/gh/Stephen-RA-King/attix/branch/main/graph/badge.svg
+[codecov-url]: https://app.codecov.io/gh/Stephen-RA-King/attix
+[codefactor-image]: https://www.codefactor.io/repository/github/Stephen-RA-King/attix/badge
+[codefactor-url]: https://www.codefactor.io/repository/github/Stephen-RA-King/attix
+[codeql-image]: https://github.com/Stephen-RA-King/attix/actions/workflows/github-code-scanning/codeql/badge.svg
+[codeql-url]: https://github.com/Stephen-RA-King/attix/actions/workflows/github-code-scanning/codeql
+[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
+[commitizen-url]: http://commitizen.github.io/cz-cli/
+[conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square
+[conventional-commits-url]: https://conventionalcommits.org
+[deepsource-image]: https://app.deepsource.com/gh/Stephen-RA-King/attix.svg/?label=active+issues&show_trend=true
+[deepsource-url]: https://app.deepsource.com/gh/Stephen-RA-King/attix/?ref=repository-badge
+[docker-image]: https://github.com/Stephen-RA-King/attix/actions/workflows/docker-image.yml/badge.svg
+[docker-url]: https://github.com/Stephen-RA-King/attix/actions/workflows/docker-image.yml
+[downloads-image]: https://static.pepy.tech/personalized-badge/attix?period=total&units=international_system&left_color=black&right_color=orange&left_text=Downloads
+[downloads-url]: https://pepy.tech/project/attix
+[format-image]: https://img.shields.io/pypi/format/attix
+[isort-image]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
+[isort-url]: https://github.com/pycqa/isort/
+[license-image]: https://img.shields.io/pypi/l/attix
+[license-url]: https://github.com/Stephen-RA-King/attix/blob/main/LICENSE
+[mypy-image]: http://www.mypy-lang.org/static/mypy_badge.svg
+[mypy-url]: http://mypy-lang.org/
+[openssf-image]: https://api.securityscorecards.dev/projects/github.com/Stephen-RA-King/attix/badge
+[openssf-url]: https://api.securityscorecards.dev/projects/github.com/Stephen-RA-King/attix
+[pre-commit-image]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+[pre-commit-url]: https://github.com/pre-commit/pre-commit
+[pre-commit.ci-image]: https://results.pre-commit.ci/badge/github/Stephen-RA-King/attix/main.svg
+[pre-commit.ci-url]: https://results.pre-commit.ci/latest/github/Stephen-RA-King/attix/main
+[pydough-image]: https://img.shields.io/badge/Cookiecutter-pydough-orange?logo=cookiecutter
+[pydough-url]: https://github.com/Stephen-RA-King/pydough
+[pypi-url]: https://pypi.org/project/attix/
+[pypi-image]: https://img.shields.io/pypi/v/attix.svg
+[python-version-image]: https://img.shields.io/pypi/pyversions/attix
+[readthedocs-image]: https://readthedocs.org/projects/attix/badge/?version=latest
+[readthedocs-url]: https://attix.readthedocs.io/en/latest/?badge=latest
+[status-image]: https://img.shields.io/pypi/status/attix.svg
+[tests-image]: https://github.com/Stephen-RA-King/attix/actions/workflows/tests.yml/badge.svg
+[tests-url]: https://github.com/Stephen-RA-King/attix/actions/workflows/tests.yml
+[versioning-image]: https://img.shields.io/badge/versioning-semver_2-blue
+[versioning-url]: https://semver.org/
+[wiki]: https://github.com/Stephen-RA-King/attix/wiki
+

attix-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+attix/__init__.py,sha256=v3eM20Wc-hPUSPBOiLTUwx6V2iPpCQn4yWb8yU3i5Ik,1054
+attix/attix.py,sha256=q2I-dvZOwPcF1fhOhGgBRgGhjmm4bFnYkr2wL3e8sS0,1958
+attix/attix_cli.py,sha256=xnEsPjTL-ftOIHIe-HOitWZNah_BTnMXgRs7NZYPFXY,619
+attix/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+attix-0.1.0.dist-info/licenses/AUTHORS.md,sha256=8FkkPj30A8G30xXXg1EgbswbtgawWtC7r-DGK532-P4,172
+attix-0.1.0.dist-info/licenses/LICENSE,sha256=XJKIts4wmJVEw2mxX-iY0xsJnKL38dCST3w2C-XGIrc,1095
+attix-0.1.0.dist-info/METADATA,sha256=E8Ty3LZbMUs7Z46umujyKJ6o1gUddJ2Ii8pbNiLOrkU,12072
+attix-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+attix-0.1.0.dist-info/entry_points.txt,sha256=OFNJWNTvGkIu1sAE55nOb5YAJQbtuGozTRYaQMYI6qw,43
+attix-0.1.0.dist-info/top_level.txt,sha256=1K3Zg6W0_ZCdfp3gDDiuXplRMgDk7FwV1MUN_w9_VKA,6
+attix-0.1.0.dist-info/RECORD,,

attix-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

attix-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+attix = attix.attix:main

attix-0.1.0.dist-info/licenses/AUTHORS.md

@@ -0,0 +1,13 @@
+# Credits
+
+## Development Lead
+
+- Stephen R A King \<sking.github@gmail.com\>
+
+## Maintainer
+
+- Stephen R A King \<sking.github@gmail.com\>
+
+## Contributors
+
+

attix-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Stephen R A King
+
+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.

attix-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+attix