pyoura

Name	pyoura JSON
Version	0.1.7 JSON
	download
home_page	None
Summary	A Python library for creating command-line spinners
upload_time	2024-06-10 09:25:29
maintainer	None
docs_url	None
author	Jack
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            
### Commands for Using the Module

1. **Installing the module:**

    ```sh
    pip install pyoura
    ```

2. **Using the spinner in a Python script:**

    ```python
    from pyoura.spinner import Spinner

    spinner = Spinner('Loading', 'dots')  # You can replace 'dots' with other spinner types
    spinner.start()

    try:
        # Simulate a long-running process
        import time
        time.sleep(5)
    finally:
        spinner.stop()
    ```

3. **Running the spinner from the command line:**

    ```sh
    pyoura <spinner-type> <message>
    ```

    Example:

    ```sh
    pyoura dots "Loading, please wait..."
    ```

4. **Creating distribution files:**

    ```sh
    python setup.py sdist bdist_wheel
    ```

5. **Uploading to TestPyPI:**

    ```sh
    twine upload --repository testpypi dist/*
    ```

6. **Uploading to PyPI:**

    ```sh
    twine upload --repository pypi dist/*
    ```

This `README.md` should help users understand how to install, use, and contribute to the Pyoura module.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyoura",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jack",
    "author_email": "kinginjack@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/7f/25/c843919966081872fecc012987d6c6d86a692b0a113eb4e473f58ee86ad7/pyoura-0.1.7.tar.gz",
    "platform": null,
    "description": "\r\n### Commands for Using the Module\r\n\r\n1. **Installing the module:**\r\n\r\n    ```sh\r\n    pip install pyoura\r\n    ```\r\n\r\n2. **Using the spinner in a Python script:**\r\n\r\n    ```python\r\n    from pyoura.spinner import Spinner\r\n\r\n    spinner = Spinner('Loading', 'dots')  # You can replace 'dots' with other spinner types\r\n    spinner.start()\r\n\r\n    try:\r\n        # Simulate a long-running process\r\n        import time\r\n        time.sleep(5)\r\n    finally:\r\n        spinner.stop()\r\n    ```\r\n\r\n3. **Running the spinner from the command line:**\r\n\r\n    ```sh\r\n    pyoura <spinner-type> <message>\r\n    ```\r\n\r\n    Example:\r\n\r\n    ```sh\r\n    pyoura dots \"Loading, please wait...\"\r\n    ```\r\n\r\n4. **Creating distribution files:**\r\n\r\n    ```sh\r\n    python setup.py sdist bdist_wheel\r\n    ```\r\n\r\n5. **Uploading to TestPyPI:**\r\n\r\n    ```sh\r\n    twine upload --repository testpypi dist/*\r\n    ```\r\n\r\n6. **Uploading to PyPI:**\r\n\r\n    ```sh\r\n    twine upload --repository pypi dist/*\r\n    ```\r\n\r\nThis `README.md` should help users understand how to install, use, and contribute to the Pyoura module.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Python library for creating command-line spinners",
    "version": "0.1.7",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "212a4b9bed244ba0e8cd068d928825ad4cf3239ee74d1c2b6b653be1a5b5912e",
                "md5": "29804d5d80b70ac79b98dfa30bf0a96c",
                "sha256": "5df17ecdc49edf15abdac2d8b5c0b18f61576ca3aaafe5c873f249cfd9eac662"
            },
            "downloads": -1,
            "filename": "pyoura-0.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29804d5d80b70ac79b98dfa30bf0a96c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 5017,
            "upload_time": "2024-06-10T09:25:25",
            "upload_time_iso_8601": "2024-06-10T09:25:25.842595Z",
            "url": "https://files.pythonhosted.org/packages/21/2a/4b9bed244ba0e8cd068d928825ad4cf3239ee74d1c2b6b653be1a5b5912e/pyoura-0.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7f25c843919966081872fecc012987d6c6d86a692b0a113eb4e473f58ee86ad7",
                "md5": "af0fe7c96390dbf016a93b975eaa502e",
                "sha256": "d6a48ade9571fd54673c79854835de5200d88aae58b40d7c24fd7462b092c3e5"
            },
            "downloads": -1,
            "filename": "pyoura-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "af0fe7c96390dbf016a93b975eaa502e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4558,
            "upload_time": "2024-06-10T09:25:29",
            "upload_time_iso_8601": "2024-06-10T09:25:29.971842Z",
            "url": "https://files.pythonhosted.org/packages/7f/25/c843919966081872fecc012987d6c6d86a692b0a113eb4e473f58ee86ad7/pyoura-0.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-10 09:25:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pyoura"
}