Metadata-Version: 2.4
Name: hello_python_empty_package
Version: 0.1.2
Summary: An empty Python project template with an add function.
Author-email: daominah <tung.daothanhtung@gmail.com>
License: BSD 2-Clause License
        
        Copyright (c) 2025, Dao Thanh Tung
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Homepage, https://github.com/daominah/hello_python_empty_package
Project-URL: Source, https://github.com/daominah/hello_python_empty_package
Project-URL: Issues, https://github.com/daominah/hello_python_empty_package/issues
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Python empty package template

Ready to be published as a library so any project can install it with pip.

## Setup

```
python -m venv .venv

# for Windows Git Bash
source .venv/Scripts/activate
# or Windows PowerShell
.venv\Scripts\Activate.ps1
# or for Linux:
source .venv/bin/activate

# pip install --upgrade pip
pip install -r requirements.txt
```

Update requirements.txt while developing:

```
pip list --not-required --format=freeze > requirements.txt
```

## Run Tests

```
export PYTHONPATH=src/hello_python_empty_package
python -m unittest -v src/hello_python_empty_package/daominahmath_test.py
```

## Build Package

```
# for the first time if not installed
# pip install build

python -m build
# Output will be in the `dist` directory
```

## Publish Package

[Python Package Index (PyPI)](https://pypi.org/manage/account/token/):

- username: daominah
- email: tung.daothanhtung@gmail.com

The following command will require your API token,
the token can only be view right after you create it, create a new token if needed.
I store the token in [.pypi_api_token](.pypi_api_token), which is gitignored.

```
# for the first time if not installed
# pip install twine

twine upload dist/*
# Output is on:
# https://pypi.org/project/hello-python-empty-package

# the 2nd time you run the upload command,
# it will return error "File already exists" if
# you have not changed the version in pyproject.toml.
```
