Metadata-Version: 2.4
Name: gatemark
Version: 0.0.2
Summary: GateMark Placeholder Package
License-Expression: Apache-2.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# GateMark

> [!WARNING]
> 0.0.2 is placeholder.

GateMark Placeholder Package.

```bash
pip install gatemark
```

---

## Publishing Guide (Placeholder & Release)

### 1. How to Update the Version Number
PyPI and TestPyPI enforce an **immutable release policy**: once a version (e.g. `0.0.1`) is published, it **cannot be overwritten or re-uploaded**. Whenever making updates:

1. Update the version string in `pyproject.toml`:
   ```toml
   [project]
   version = "0.0.2"
   ```
2. Update the version string in `src/gatemark/__init__.py`:
   ```python
   __version__ = "0.0.2"
   ```
3. Remove old distribution files before rebuilding:
   - **PowerShell (Windows)**:
     ```powershell
     Remove-Item -Recurse -Force dist
     ```
   - **Bash (Linux/macOS)**:
     ```bash
     rm -rf dist
     ```

### 2. Prerequisites & Setup

Ensure you have Python and `uv` installed, then set up the virtual environment with build dependencies:

```bash
# Create virtual environment
uv venv

# Install build & twine
uv pip install build twine
```

### 3. Build Package
Clean previous artifacts and build the new distribution files:

```bash
uv run python -m build
```

The output packages will be located in the `dist/` folder (e.g., `gatemark-0.0.2.tar.gz` and `gatemark-0.0.2-py3-none-any.whl`).

### 4. Upload to TestPyPI (Verification)
Upload to TestPyPI to test packaging and metadata rendering:

```bash
uv run twine upload -r testpypi dist/*
```

- **Username**: `__token__`
- **Password**: Your TestPyPI API token (begins with `pypi-...`)

Check package rendering at: `https://test.pypi.org/project/gatemark/`

### 5. Upload to PyPI (Production)
Once verified on TestPyPI, publish to official PyPI:

```bash
uv run twine upload dist/*
```

- **Username**: `__token__`
- **Password**: Your PyPI API token (begins with `pypi-...`)

Verify the release at: `https://pypi.org/project/gatemark/`

