| Name | cli-sliding-puzzle JSON |
| Version |
0.1.4.post0
JSON |
| download |
| home_page | None |
| Summary | A CLI sliding puzzle game |
| upload_time | 2024-10-12 21:11:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
game
puzzle
cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CLI Sliding Puzzle Game
A command-line interface sliding puzzle game built with Python.
## Installation
To install the game, you need Python 3.7 or higher and pip. Then run:
pip install cli-sliding-puzzle
## Playing the Game
After installation, run the game by typing:
sliding-puzzle
Use arrow keys to move tiles. Press 'q' to quit.
## Development
### Setup
1. Clone the repository:
git clone https://github.com/yourusername/cli-sliding-puzzle.git
cd cli-sliding-puzzle
2. Create a virtual environment:
python -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
3. Install development dependencies:
pip install build twine setuptools_scm
### Building and Publishing
1. Ensure all changes are committed to git.
2. List existing tags to determine the next version number:
```bash
git tag --list
```
3. Create a new git tag for the version:
```bash
git tag -a vX.X.X -m "Release version X.X.X"
git push origin vX.X.X
```
4. Clean up the dist directory:
```bash
rm -rf dist/*
```
5. Build the package:
```bash
python -m build
```
6. Test the package locally:
```bash
# List the contents of the dist directory
ls dist/
# Install the latest version (replace X.X.X with the latest version number you see)
pip install dist/cli_sliding_puzzle-X.X.X-py3-none-any.whl
```
7. Upload to TestPyPI:
```bash
twine upload --repository testpypi dist/*
```
8. Test the TestPyPI upload:
```bash
# Create a new virtual environment for testing
python -m venv test_venv
source test_venv/bin/activate # On Windows, use `test_venv\Scripts\activate`
# Install the package from TestPyPI
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple cli-sliding-puzzle
# Test the installed package
sliding-puzzle
# Deactivate the test environment when done
deactivate
```
9. If everything works, upload to PyPI:
```bash
twine upload dist/*
```
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "cli-sliding-puzzle",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "game, puzzle, cli",
"author": null,
"author_email": "Wade Wegner <wade.wegner@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3f/b6/758af83c861cf4d4791a175de002304bee1158a3b0fb6334e0b1ff3aade0/cli_sliding_puzzle-0.1.4.post0.tar.gz",
"platform": null,
"description": "# CLI Sliding Puzzle Game\n\nA command-line interface sliding puzzle game built with Python.\n\n## Installation\n\nTo install the game, you need Python 3.7 or higher and pip. Then run:\n\npip install cli-sliding-puzzle\n\n## Playing the Game\n\nAfter installation, run the game by typing:\n\nsliding-puzzle\n\nUse arrow keys to move tiles. Press 'q' to quit.\n\n## Development\n\n### Setup\n\n1. Clone the repository:\n git clone https://github.com/yourusername/cli-sliding-puzzle.git\n cd cli-sliding-puzzle\n\n2. Create a virtual environment:\n python -m venv venv\n source venv/bin/activate # On Windows, use `venv\\Scripts\\activate`\n\n3. Install development dependencies:\n pip install build twine setuptools_scm\n\n### Building and Publishing\n\n1. Ensure all changes are committed to git.\n\n2. List existing tags to determine the next version number:\n ```bash\n git tag --list\n ```\n\n3. Create a new git tag for the version:\n ```bash\n git tag -a vX.X.X -m \"Release version X.X.X\"\n git push origin vX.X.X\n ```\n\n4. Clean up the dist directory:\n ```bash\n rm -rf dist/*\n ```\n\n5. Build the package:\n ```bash\n python -m build\n ```\n\n6. Test the package locally:\n ```bash\n # List the contents of the dist directory\n ls dist/\n \n # Install the latest version (replace X.X.X with the latest version number you see)\n pip install dist/cli_sliding_puzzle-X.X.X-py3-none-any.whl\n ```\n\n7. Upload to TestPyPI:\n ```bash\n twine upload --repository testpypi dist/*\n ```\n\n8. Test the TestPyPI upload:\n ```bash\n # Create a new virtual environment for testing\n python -m venv test_venv\n source test_venv/bin/activate # On Windows, use `test_venv\\Scripts\\activate`\n\n # Install the package from TestPyPI\n pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple cli-sliding-puzzle\n\n # Test the installed package\n sliding-puzzle\n\n # Deactivate the test environment when done\n deactivate\n ```\n\n9. If everything works, upload to PyPI:\n ```bash\n twine upload dist/*\n ```\n\n## License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CLI sliding puzzle game",
"version": "0.1.4.post0",
"project_urls": null,
"split_keywords": [
"game",
" puzzle",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "872f1576fc9392fcccd073c6ee77d5818c182e94b305c6ddab4e5706cd458988",
"md5": "0d187d6fab534a3115dedc70a5c6d72f",
"sha256": "1fbe0158cb6cecb6ec73168640f2503264426f46344119b1b31d69332df62a2f"
},
"downloads": -1,
"filename": "cli_sliding_puzzle-0.1.4.post0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d187d6fab534a3115dedc70a5c6d72f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4208,
"upload_time": "2024-10-12T21:11:50",
"upload_time_iso_8601": "2024-10-12T21:11:50.423596Z",
"url": "https://files.pythonhosted.org/packages/87/2f/1576fc9392fcccd073c6ee77d5818c182e94b305c6ddab4e5706cd458988/cli_sliding_puzzle-0.1.4.post0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3fb6758af83c861cf4d4791a175de002304bee1158a3b0fb6334e0b1ff3aade0",
"md5": "dc7262b4662428e0f81fdce2309a5e3a",
"sha256": "1f4049a6218862216c05a3fd525b0f7d5de7db5923bb706316e0e3a5c5e720fd"
},
"downloads": -1,
"filename": "cli_sliding_puzzle-0.1.4.post0.tar.gz",
"has_sig": false,
"md5_digest": "dc7262b4662428e0f81fdce2309a5e3a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3956,
"upload_time": "2024-10-12T21:11:52",
"upload_time_iso_8601": "2024-10-12T21:11:52.197643Z",
"url": "https://files.pythonhosted.org/packages/3f/b6/758af83c861cf4d4791a175de002304bee1158a3b0fb6334e0b1ff3aade0/cli_sliding_puzzle-0.1.4.post0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 21:11:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cli-sliding-puzzle"
}
