Metadata-Version: 2.1
Name: pypak
Version: 1.1.4
Summary: python-repo template
Home-page: https://github.com/reactive-firewall/python-repo
Download-URL: https://github.com/reactive-firewall/python-repo.git
Author: reactive-firewall
Author-email: reactive-firewall@users.noreply.github.com
License: MIT License
        
        Copyright (c) 2018-2024 reactive-firewall
        
        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.
        
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Networking
Obsoletes: S
Obsoletes: e
Obsoletes: e
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.md
Requires-Dist: setuptools>=45.0
Requires-Dist: virtualenv>=15.0.1
Requires-Dist: six>=1.0.0
Requires-Dist: tox>=3.0.0
Requires-Dist: pip>=21.0

# Python Accessory Kit (pypak)

## Table of Contents

- [About](#about)
- [Status](#status)
  - [Master Branch](#master-branch)
  - [Stable Branch](#stable-branch)
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
  - [Modules](#modules)
  - [Scripts](#scripts)
  - [Documentation](#documentation)
  - [Tests](#tests)
- [Development](#development)
  - [Testing](#testing)
  - [Style Guidelines](#style-guidelines)
- [Dependencies](#dependencies)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)

## About

The Python Accessory Kit (pypak) is a collection of Python utilities and scripts designed to assist
with various development tasks.

## Status

### Master Branch

[![status](https://travis-ci.org/reactive-firewall/pypak.svg?branch=master)](https://travis-ci.org/reactive-firewall/pypak)
[![CircleCI](https://circleci.com/gh/reactive-firewall/pypak/tree/master.svg?style=svg)](https://circleci.com/gh/reactive-firewall/pypak/tree/master)
[![Appveyor](https://ci.appveyor.com/api/projects/status/pypak/branch/master?svg=true)](https://ci.appveyor.com/project/reactive-firewall/pypak/branch/master)
[![Python 3](https://pyup.io/repos/github/reactive-firewall/pypak/python-3-shield.svg)](https://pyup.io/repos/github/reactive-firewall/pypak/)
[![Updates](https://pyup.io/repos/github/reactive-firewall/pypak/shield.svg)](https://pyup.io/repos/github/reactive-firewall/pypak/)
[![Test Coverage](https://api.codeclimate.com/v1/badges/pypak/test_coverage)](https://codeclimate.com/github/reactive-firewall/pypak/test_coverage)
[![Code Coverage](https://codecov.io/gh/reactive-firewall/pypak/branch/master/graph/badge.svg)](https://codecov.io/gh/reactive-firewall/pypak/branch/master/)
[![Coverage Status](https://coveralls.io/repos/github/reactive-firewall/pypak/badge.svg?branch=master)](https://coveralls.io/github/reactive-firewall/pypak?branch=master)
[![Code Climate](https://codeclimate.com/github/reactive-firewall/pypak/badges/gpa.svg)](https://codeclimate.com/github/reactive-firewall/pypak)
[![CodeFactor](https://www.codefactor.io/repository/github/reactive-firewall/pypak/badge)](https://www.codefactor.io/repository/github/reactive-firewall/pypak)
[![codebeat badge](https://codebeat.co/badges/da1d8064-5736-49fd-9d61-d046aca38afb)](https://codebeat.co/projects/github-com-reactive-firewall-pypak-master)
![Size](https://img.shields.io/github/languages/code-size/reactive-firewall/pypak.svg)
![commits-since](https://img.shields.io/github/commits-since/reactive-firewall/pypak/stable.svg?maxAge=9000)

### Stable Branch

[CI](gha link goes here)
[![CircleCI](https://circleci.com/gh/reactive-firewall/pypak/tree/stable.svg?style=svg)](https://circleci.com/gh/reactive-firewall/pypak/tree/stable)
[![Appveyor](https://ci.appveyor.com/api/projects/status/6gggp1wpbnnjokm4/branch/stable?svg=true)](https://ci.appveyor.com/project/reactive-firewall/pypak/branch/stable)
[![Code Coverage](https://codecov.io/gh/reactive-firewall/pypak/branch/stable/graph/badge.svg)](https://codecov.io/gh/reactive-firewall/pypak/branch/stable/)
[![Coverage Status](https://coveralls.io/repos/github/reactive-firewall/pypak/badge.svg?branch=stable)](https://coveralls.io/github/reactive-firewall/pypak?branch=stable)
[![codebeat badge](https://codebeat.co/badges/87520e4a-6d24-4e98-a61e-6e9efc58f783)](https://codebeat.co/projects/github-com-reactive-firewall-pypak-stable)

## Installation

Clone the repository and navigate to the project directory:

```bash
git clone https://github.com/reactive-firewall/pypak.git
cd pypak
```

Install the required dependencies:

```bash
pip install -r requirements.txt
```

## Usage

pypak provides a set of modules and scripts that can be utilized in your Python projects. You can
import the modules in your Python code as follows:

```python
import pypak
```

## Features

### Modules

- `pypak/__init__.py`: The initialization module for pypak.
- `pypak/anything.py`: Contains the `anything` and `nothing` classes, providing generic object
implementations with extensive method overloading and testing examples.

### Scripts

- `setup.py`: Script to install the pypak package.
- `Makefile`: Contains development, testing, and cleaning commands for ease of use.

### Documentation

> [!NOTE]
> **WIP** Documentation is a work in progress. :construction:

Located in the `docs/` directory:

- `conf.py`: Configuration for Sphinx documentation generation.
- `index.md`: The main page for project documentation.
- `Makefile` and `make.bat`: Scripts to build documentation in various formats.

### Tests

Located in the `tests/` directory.

## Development

### Testing

For testing, use the provided `Makefile` commands:

- Run unit tests:

```bash
make clean
make test
```

- Check code style according to CEP-8 conventions:

```bash
make clean
make test-style
```

- Run tests across multiple environments using Tox:

```bash
make clean
make test-tox
```

### Style Guidelines

This project follows custom coding standards:

- **CEP-8**: A style guide for Python code, similar to PEP 8 but with project-specific conventions.
- **CEP-5**: A style guide for Bash scripts, detailing conventions for script structure and
  formatting.

Please ensure all Python and Bash code adheres to these standards.

## Dependencies

The project dependencies are listed in `requirements.txt`.

## Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Ensure your code follows the CEP-8 (Python) or CEP-5 (Bash) coding standards.
4. Submit a pull request with a detailed description of your changes.

## License

[![MIT License](https://img.shields.io/github/license/reactive-firewall/pypak.svg?maxAge=2592000)](https://github.com/reactive-firewall/pypak/blob/stable/LICENSE.md)

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Acknowledgments

- **Third-party Acknowledgement**:

  Some code, particularly in `tests/profiling.py`, was modified or derived from
  [Zapier's profiling-python-like-a-boss project](https://github.com/zapier/profiling-python-like-a-boss/tree/1ab93a1154).
  This code is under the BSD-3-Clause license. See the
  [LICENSE](https://github.com/zapier/profiling-python-like-a-boss/blob/1ab93a1154/LICENSE.md) for
  details.

- **Special Thanks**:

  Thanks to all contributors and the open-source community for their invaluable support and
  resources.
