| Name | ayrun-pyrps JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/ayrun3412/PyRPS |
| Summary | Instantly play rock-paper-scissors with a simple CLI interface ⚔️ |
| upload_time | 2024-08-25 17:49:26 |
| maintainer | None |
| docs_url | None |
| author | ayrun |
| requires_python | <4.0,>=3.12 |
| license | MIT |
| keywords |
rps
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="./assets/PyRPS_banner.png" alt="PyRPS Logo"/>
</p>
<hr>
<p align="center">
<i>Instantly play rock-paper-scissors with a simple CLI interface ⚔️</i>
</p>
<p align="center">
<img src="./assets/PyRPS.gif" alt="Description"/>
</p>
<p align="center">
<a href="#-about">🧐 About</a> •
<a href="#-features">✨ Features</a> •
<a href="#-installation">🛠️ Installation</a> •
<a href="#-usage">🚀 Usage</a> •
<a href="#-contributing">🤝 Contributing</a> •
<a href="#-license">📄 License</a> •
<a href="#-contact">📫 Contact</a>
</p>
## 🧐 About
**PyRPS** is a straightforward command-line interface (CLI) game for playing rock-paper-scissors. It’s built in Python and designed for quick, casual gameplay. Whether you’re looking to kill some time or practice Python scripting, PyRPS offers a fun and simple experience.
## ✨ Features
- **Simple CLI Interface**: Play rock-paper-scissors directly in your terminal.
- **Lightweight**: Minimal dependencies make it quick and easy to run.
- **Cross-Platform**: Works on Windows, MacOS & Linux!
## 🛠️ Installation
PyRPS can be installed via **pip**!
However, make sure that you have **Python version 3.11 or greater** installed in your system.
- **For Windows**
```bash
pip install ayrun-pyrps
```
- **For MacOS & Linux**
```bash
pip3 install ayrun-pyrps
```
## 🚀 Usage
After installing, run the `rps` command in your console to run PyRPS!
```bash
rps
```
## 🤝 Contributing
Contributions are welcome! Please follow these steps to contribute:
1. **Fork the project**
2. **Create a new branch**
```bash
git checkout -b feature/YourFeature
```
3. **Commit your changes**
```bash
git commit -m "Add YourFeature"
```
4. **Push to the branch**
```bash
git push origin feature/YourFeature
```
5. **Open a Pull Request( PR )**
<br>
Please make sure your code is **well-documented** and follows the **project's coding style**.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
## 📫 Contact
For any questions or suggestions, feel free to reach out:
- **Email**: ayrun3412@gmail.com
- **Discord**: its.ayrun
- **GitHub Issues**
---
Raw data
{
"_id": null,
"home_page": "https://github.com/ayrun3412/PyRPS",
"name": "ayrun-pyrps",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "rps, cli",
"author": "ayrun",
"author_email": "ayrun3412@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3e/74/dda89ace0e23d5df5376c6fa7321293b02ffadfd1f32594b4394fd6d063d/ayrun_pyrps-0.1.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"./assets/PyRPS_banner.png\" alt=\"PyRPS Logo\"/>\n</p>\n<hr>\n<p align=\"center\">\n <i>Instantly play rock-paper-scissors with a simple CLI interface \u2694\ufe0f</i>\n</p>\n<p align=\"center\">\n <img src=\"./assets/PyRPS.gif\" alt=\"Description\"/>\n</p>\n\n<p align=\"center\">\n <a href=\"#-about\">\ud83e\uddd0 About</a> \u2022\n <a href=\"#-features\">\u2728 Features</a> \u2022\n <a href=\"#-installation\">\ud83d\udee0\ufe0f Installation</a> \u2022\n <a href=\"#-usage\">\ud83d\ude80 Usage</a> \u2022\n <a href=\"#-contributing\">\ud83e\udd1d Contributing</a> \u2022\n <a href=\"#-license\">\ud83d\udcc4 License</a> \u2022\n <a href=\"#-contact\">\ud83d\udceb Contact</a>\n</p>\n\n## \ud83e\uddd0 About\n\n**PyRPS** is a straightforward command-line interface (CLI) game for playing rock-paper-scissors. It\u2019s built in Python and designed for quick, casual gameplay. Whether you\u2019re looking to kill some time or practice Python scripting, PyRPS offers a fun and simple experience.\n\n## \u2728 Features\n\n- **Simple CLI Interface**: Play rock-paper-scissors directly in your terminal.\n\n- **Lightweight**: Minimal dependencies make it quick and easy to run.\n\n- **Cross-Platform**: Works on Windows, MacOS & Linux!\n\n## \ud83d\udee0\ufe0f Installation\n\nPyRPS can be installed via **pip**!\nHowever, make sure that you have **Python version 3.11 or greater** installed in your system.\n\n- **For Windows**\n\n```bash\npip install ayrun-pyrps\n```\n\n- **For MacOS & Linux**\n\n```bash\npip3 install ayrun-pyrps\n```\n\n## \ud83d\ude80 Usage\n\nAfter installing, run the `rps` command in your console to run PyRPS!\n\n```bash\nrps\n```\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please follow these steps to contribute:\n\n1. **Fork the project**\n\n2. **Create a new branch**\n\n```bash\ngit checkout -b feature/YourFeature\n```\n\n3. **Commit your changes**\n\n```bash\ngit commit -m \"Add YourFeature\"\n```\n\n4. **Push to the branch**\n\n```bash\ngit push origin feature/YourFeature\n```\n\n5. **Open a Pull Request( PR )**\n\n<br>\n\nPlease make sure your code is **well-documented** and follows the **project's coding style**.\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.\n\n## \ud83d\udceb Contact\n\nFor any questions or suggestions, feel free to reach out:\n\n- **Email**: ayrun3412@gmail.com\n- **Discord**: its.ayrun\n- **GitHub Issues**\n\n---\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Instantly play rock-paper-scissors with a simple CLI interface \u2694\ufe0f",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/ayrun3412/PyRPS",
"Repository": "https://github.com/ayrun3412/PyRPS"
},
"split_keywords": [
"rps",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "575ce895514693d5e917c6b52d8f27ad548a7cfdf0457961001cc0b2768cbf5e",
"md5": "7b2ecc8fa298792ef7be1a893d12a625",
"sha256": "9f41bafaf1c267f786d0c27cef4c6743a6b0cac4fdf687ba7841e5f6d85262a0"
},
"downloads": -1,
"filename": "ayrun_pyrps-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b2ecc8fa298792ef7be1a893d12a625",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 8330,
"upload_time": "2024-08-25T17:49:25",
"upload_time_iso_8601": "2024-08-25T17:49:25.676419Z",
"url": "https://files.pythonhosted.org/packages/57/5c/e895514693d5e917c6b52d8f27ad548a7cfdf0457961001cc0b2768cbf5e/ayrun_pyrps-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e74dda89ace0e23d5df5376c6fa7321293b02ffadfd1f32594b4394fd6d063d",
"md5": "3f782cfaa216673766d474f9e8219e35",
"sha256": "07b0b42637c496455e5afa300814e53e3d49a8fdd134b49f1aec28e7aec3a12d"
},
"downloads": -1,
"filename": "ayrun_pyrps-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3f782cfaa216673766d474f9e8219e35",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 5379,
"upload_time": "2024-08-25T17:49:26",
"upload_time_iso_8601": "2024-08-25T17:49:26.994033Z",
"url": "https://files.pythonhosted.org/packages/3e/74/dda89ace0e23d5df5376c6fa7321293b02ffadfd1f32594b4394fd6d063d/ayrun_pyrps-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 17:49:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ayrun3412",
"github_project": "PyRPS",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ayrun-pyrps"
}
