pypak 1.1.4

python-repo template

Python Accessory Kit (pypak)

Table of Contents

• About
• Status
  • Master Branch
  • Stable Branch
• Installation
• Usage
• Features
  • Modules
  • Scripts
  • Documentation
  • Tests
• Development
  • Testing
  • Style Guidelines
• Dependencies
• Contributing
• License
• 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

Stable Branch

[CI](gha link goes here)

Installation

Clone the repository and navigate to the project directory:

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

Install the required dependencies:

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:

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:

make clean
make test

• Check code style according to CEP-8 conventions:

make clean
make test-style

• Run tests across multiple environments using Tox:

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

This project is licensed under the MIT License - see the 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. This code is under the BSD-3-Clause license. See the LICENSE for details.

• Special Thanks:

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