Metadata-Version: 2.4
Name: charlie-game-compendium
Version: 0.1.0
Summary: A small collection I made - hope u enjoy!.
Author: Charlie Lindsay
License-Expression: MIT
Project-URL: Homepage, https://github.com/CharlieLindsay/charlie-s-game-compendium
Keywords: game,terminal,cli,connect-four,tic-tac-toe
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Games/Entertainment
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Charlie's Game Compendium

A small collection of terminal games, playable straight from your command line:

- **Connect 4**
- **Number Guesser**
- **Tic Tac Toe**

Each game keeps its own local leaderboard, and the app remembers your name between sessions.

## Install

Once published to PyPI:

```
pip install charlie-game-compendium
```

## Play

```
charlie-games
```

That's it — the installer adds a `charlie-games` command to your PATH, so it runs from any directory.

## Data storage

Your saved name and each game's leaderboard are stored as plain text files under
`~/.charlie_game_compendium/` (your home directory), not in your current folder,
so the command works the same no matter where you run it from.

## Development

Clone the repo and install it locally in editable mode to test changes without
reinstalling each time:

```
git clone https://github.com/CharlieLindsay/charlie-s-game-compendium.git
cd charlie-s-game-compendium
pip install -e .
charlie-games
```

## Publishing a new version to PyPI

1. Bump the `version` field in `pyproject.toml`.
2. Build the distribution files:

   ```
   pip install --upgrade build twine
   python -m build
   ```

   This creates a `dist/` folder with a `.tar.gz` and a `.whl` file.
3. Upload to PyPI (you'll need a PyPI account and an API token):

   ```
   python -m twine upload dist/*
   ```

   Twine will prompt for a username and password — use `__token__` as the
   username and your PyPI API token (starting with `pypi-`) as the password.
4. Once it's live, anyone can install it with `pip install charlie-game-compendium`.

It's worth doing a search on [pypi.org](https://pypi.org) for the project name
before your first upload — package names can't be changed or reused later.
