zsz-package 0.1.0

A sample Python package that can be uploaded to PyPI

ZSZ Package

A sample Python package demonstrating how to create a package that can be uploaded to PyPI.

Features

• Simple and easy to use
• Well-documented code
• Comprehensive test coverage
• Ready for PyPI distribution

Installation

From PyPI (once published)

pip install zsz-package

From source

git clone https://github.com/yourusername/zsz-package.git
cd zsz-package
pip install -e .

Usage

As a Python library

from zsz_package import hello, Calculator

# Say hello
hello("World")

# Use the calculator
calc = Calculator()
result = calc.add(5, 3)
print(f"Result: {result}")

Command-line interface

zsz-hello

Development

Setup development environment

# Clone the repository
git clone https://github.com/yourusername/zsz-package.git
cd zsz-package

# Install in editable mode with dev dependencies
pip install -e ".[dev]"

Run tests

pytest

Code formatting

black src/ tests/

Type checking

mypy src/

Building and Publishing

Build the package

# Install build tools
pip install build twine

# Build the package
python -m build

This will create distribution files in the dist/ directory:

• zsz_package-0.1.0.tar.gz (source distribution)
• zsz_package-0.1.0-py3-none-any.whl (wheel distribution)

Test the package locally

# Install from local wheel
pip install dist/zsz_package-0.1.0-py3-none-any.whl

Upload to TestPyPI (for testing)

# Upload to TestPyPI
python -m twine upload --repository testpypi dist/*

# Test installation from TestPyPI
pip install --index-url https://test.pypi.org/simple/ zsz-package

Upload to PyPI (production)

# Upload to PyPI
python -m twine upload dist/*

Note: You need to:

1. Create an account on PyPI or TestPyPI
2. Configure your credentials (use API tokens for better security)
3. Ensure your package name is unique on PyPI

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Your Name - [e-mail]

Changelog

0.1.0 (2026-01-02)

• Initial release
• Basic calculator functionality
• Hello world function
• Command-line interface