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

