xkivy


Namexkivy JSON
Version 1.1.1 PyPI version JSON
download
home_page
SummaryA kivy extension module to add functionality and making new widgets accessible to both kivy and kivymd.
upload_time2023-11-01 21:17:08
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords kivy xkivy app kivymd
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![icon](https://github.com/digreatbrian/xkivy/blob/main/assets/xkivy.jpg)

# XKivy

A kivy and kivymd extension module for easy accessibility, creation of new widgets and also adding more functionality. 

This module containing new advanced widgets that are readily available to suit your needs.

You may use this module with kivymd module for the best experience.This module was built to incorporate new widgets to kivy and kivymd ,to provide flexibility with widgets ,to add functionality and to fix some problems with kivymd.

## Getting Started

You can get this module to run on your machine through installing it with pip. 

Using Pip

    python -m pip install xkivy
	
 
### Prerequisites

There is only the need of kivy and kivymd for this module to be running. 

```
kivymd >= 1.2.0
kivy >= 2.0.0

```

### Installing

Installing is simple, through downloading the necessary files and then install or through pip. 

Using Pip

```
pip install xkivy

```

Downloading and then installing
Through Git 

```
git clone https://github.com/digreatbrian/xkivy.git
cd xkivy
python setup.py install

```
<b>or</b> 

```
git clone https://github.com/digreatbrian/xkivy.git
cd xkivy
pip install .
```
##
<b>Or Through tar.gz file</b>
```
pip install xkivy-1.0.1.tar.gz

```

## Deployment

To use this module, you just have to do the same procedure when creating a kivy/kivymd App. 

Example
```
    from kivy.app import App
    from xkivy.uix.button import XRectangularButton as XButton

    class TestApp(App):
        def build(self):
            return XButton(text='Test Button') 

    app=TestApp() 
    app.run()
```
## Contributing

Please read [CONTRIBUTING.md](https://github.com/digreatbrian/xkivy/contributors) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

* **Brian Musakwa** - *Initial work* - [digreatbrian](https://github.com/digreatbrian)

See also the list of [contributors](https://github.com/digreatbrian/xkivy/contributors) who participated in this project.

## Widgets
To see the flexible widgets that xkivy has ,please follow [UIX-WIDGETS](https://github.com/digreatbrian/xkivy/blob/main/UIXDocumentation.md)

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/digreatbrian/xkivy/blob/main/LICENSE) file for details

## Acknowledgments

* I hereby thank everyone who has contributed to this software. 











            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "xkivy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "kivy,xkivy,app,kivymd",
    "author": "",
    "author_email": "Brian Musakwa <digreatbrian@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/cd/3d/b621984fef376a67e231ad79013a31c64ef46d72b8b2d189f0651aeeee08/xkivy-1.1.1.tar.gz",
    "platform": null,
    "description": "![icon](https://github.com/digreatbrian/xkivy/blob/main/assets/xkivy.jpg)\r\n\r\n# XKivy\r\n\r\nA kivy and kivymd extension module for easy accessibility, creation of new widgets and also adding more functionality. \r\n\r\nThis module containing new advanced widgets that are readily available to suit your needs.\r\n\r\nYou may use this module with kivymd module for the best experience.This module was built to incorporate new widgets to kivy and kivymd ,to provide flexibility with widgets ,to add functionality and to fix some problems with kivymd.\r\n\r\n## Getting Started\r\n\r\nYou can get this module to run on your machine through installing it with pip. \r\n\r\nUsing Pip\r\n\r\n    python -m pip install xkivy\r\n\t\r\n \r\n### Prerequisites\r\n\r\nThere is only the need of kivy and kivymd for this module to be running. \r\n\r\n```\r\nkivymd >= 1.2.0\r\nkivy >= 2.0.0\r\n\r\n```\r\n\r\n### Installing\r\n\r\nInstalling is simple, through downloading the necessary files and then install or through pip. \r\n\r\nUsing Pip\r\n\r\n```\r\npip install xkivy\r\n\r\n```\r\n\r\nDownloading and then installing\r\nThrough Git \r\n\r\n```\r\ngit clone https://github.com/digreatbrian/xkivy.git\r\ncd xkivy\r\npython setup.py install\r\n\r\n```\r\n<b>or</b> \r\n\r\n```\r\ngit clone https://github.com/digreatbrian/xkivy.git\r\ncd xkivy\r\npip install .\r\n```\r\n##\r\n<b>Or Through tar.gz file</b>\r\n```\r\npip install xkivy-1.0.1.tar.gz\r\n\r\n```\r\n\r\n## Deployment\r\n\r\nTo use this module, you just have to do the same procedure when creating a kivy/kivymd App. \r\n\r\nExample\r\n```\r\n    from kivy.app import App\r\n    from xkivy.uix.button import XRectangularButton as XButton\r\n\r\n    class TestApp(App):\r\n        def build(self):\r\n            return XButton(text='Test Button') \r\n\r\n    app=TestApp() \r\n    app.run()\r\n```\r\n## Contributing\r\n\r\nPlease read [CONTRIBUTING.md](https://github.com/digreatbrian/xkivy/contributors) for details on our code of conduct, and the process for submitting pull requests to us.\r\n\r\n## Authors\r\n\r\n* **Brian Musakwa** - *Initial work* - [digreatbrian](https://github.com/digreatbrian)\r\n\r\nSee also the list of [contributors](https://github.com/digreatbrian/xkivy/contributors) who participated in this project.\r\n\r\n## Widgets\r\nTo see the flexible widgets that xkivy has ,please follow [UIX-WIDGETS](https://github.com/digreatbrian/xkivy/blob/main/UIXDocumentation.md)\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/digreatbrian/xkivy/blob/main/LICENSE) file for details\r\n\r\n## Acknowledgments\r\n\r\n* I hereby thank everyone who has contributed to this software. \r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A kivy extension module to add functionality and making new widgets accessible to both kivy and kivymd.",
    "version": "1.1.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/digreatbrian/xkivy/issues",
        "Homepage": "https://github.com/digreatbrian/xkivy",
        "UIX Docs": "https://github.com/digreatbrian/xkivy/blob/main/UIXDocumentation.md"
    },
    "split_keywords": [
        "kivy",
        "xkivy",
        "app",
        "kivymd"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b15545a40ed24990bd527f6839618b3b3c1529ed11b3de5439621ca951ae5f4",
                "md5": "66fb4f70e975d98350b649e7cb6d6d8a",
                "sha256": "8ee60ad7838d81266565db02f6714094cc1fa4219399e4a0af1e1145eb791534"
            },
            "downloads": -1,
            "filename": "xkivy-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66fb4f70e975d98350b649e7cb6d6d8a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 30223,
            "upload_time": "2023-11-01T21:17:06",
            "upload_time_iso_8601": "2023-11-01T21:17:06.892426Z",
            "url": "https://files.pythonhosted.org/packages/0b/15/545a40ed24990bd527f6839618b3b3c1529ed11b3de5439621ca951ae5f4/xkivy-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd3db621984fef376a67e231ad79013a31c64ef46d72b8b2d189f0651aeeee08",
                "md5": "504971f8fd5c52def8fc3d575f54b11d",
                "sha256": "b25ce94ce7ad20516402fbd78dabff2137523782581e691e8c8a2e1692dec0dd"
            },
            "downloads": -1,
            "filename": "xkivy-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "504971f8fd5c52def8fc3d575f54b11d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 25009,
            "upload_time": "2023-11-01T21:17:08",
            "upload_time_iso_8601": "2023-11-01T21:17:08.813932Z",
            "url": "https://files.pythonhosted.org/packages/cd/3d/b621984fef376a67e231ad79013a31c64ef46d72b8b2d189f0651aeeee08/xkivy-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-01 21:17:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "digreatbrian",
    "github_project": "xkivy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "xkivy"
}
        
Elapsed time: 0.13300s