mdsanima-dev


Namemdsanima-dev JSON
Version 0.2.0 PyPI version JSON
download
home_page
SummaryMDSANIMA-DEV Python Development Tools
upload_time2023-05-12 10:06:48
maintainer
docs_urlNone
author
requires_python>=3.10
licenseMIT License Copyright (c) 2021 - 2022 Marcin Różewski <marcinrozewski@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords animation automatic bash changelog cli colors command-line console-app console-application console development emoj mdsanima-dev mdsanima python-library python python3 shell-script shell terminal tools versioning vfx zsh
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # mdsanima-dev

[![license-mdsanima][badge-01]][link-01]
[![latest-version-on-pypi][badge-02]][link-02]
[![github-top-language][badge-03]][link-01]
[![pypi-python-version][badge-04]][link-02]
[![code-style-black][badge-05]][link-03]

[![pype-total-downloads][badge-pe]][link-04]
[![github-repo-stars][badge-06]][link-01]
[![github-open-issues][badge-07]][link-05]
[![github-closed-issues][badge-08]][link-06]
[![github-deployments][badge-09]][link-07]
[![github-pages-documentation][badge-10]][link-08]

_Python_ package [mdsanima-dev][link-02] is for colorizing, adding emoji and making table on console shell print output.
You can find here _Python_ modules that's make coding easier and cooler, includes several useful modules that we're use
in various projects. In the future we're add more cool function on this package.

Docomentation available at [GitHub Pages][link-08], be sure to check it.

## Installation `Options`

Instructions how to install the _Python_ package [mdsanima-dev][link-02] on your system.

<!-- start help-installation -->

Options [PyPI](#using-pypi) allows you to install the package **globally** on your system. If you want to install the
package in an **isolated environment** on your system use the [virtualenv](#using-virtualenv) options.

<!-- end help-installation -->

### Using `PyPI`

<!-- start help-using-pypi -->

Install latest version:

```shell
python3 -m pip install mdsanima-dev
```

Install specific version:

```shell
python3 -m pip install mdsanima-dev==0.2.0
```

Upgrade package to latest version:

```shell
python3 -m pip install --upgrade mdsanima-dev
```

Reinstall package to latest version:

```shell
python3 -m pip install --force-reinstall msdsanima-dev
```

Uninstall package:

```shell
python3 -m pip uninstall mdsanima-dev
```

<!-- end help-using-pypi -->

### Using `virtualenv`

<!-- start help-on-virtualenv -->

Clone repository with all number of commits history using HTTPS:

```shell
git clone https://github.com/mdsanima-dev/mdsanima-dev.git
```

Clone repository with the specified number of commits history using SSH:

```shell
git clone --depth=1 git@github.com:mdsanima-dev/mdsanima-dev.git
```

Then go to the repository directory:

```shell
cd mdsanima-dev
```

Create isolated environment with specific package version then activate and install requirements, type in terminal:

```shell
virtualenv --setuptools 67.7.2 --wheel 0.40.0 --pip 23.1.2 .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
pip install -r requirements-doc.txt
```

Install build tools for creating distribution, then build package from source, type in terminal:

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

Finnaly install the package in virtual environment, type in the terminal:

```shell
pip install --force-reinstall dist/mdsanima_dev-0.2.0-py3-none-any.whl
```

In this case I used the `--force-reinstall` option because I had an earlier version of this package already installed.

Also you can build Sphinx documentation, type in terminal:

```shell
python setup.py build_sphinx
cd build/dirhtml
python -m http.server 8080
```

Now open [localhost](http://localhost:8080) to see the documentation.

Deactivate virtual environment, type in the terminal:

```shell
deactivate
```

<!-- end help-on-virtualenv -->

## Develempent

Instruction for the _Python_ package development. Please check the [documentation][link-08] site for more information.

## Showcase

![mdsanima-dev-python-show](docs/_images/gif/mdsanima_dev_python_show.gif)

## Follow Me

These are my social media account, be sure to check it. Thanks!

[![github-followers-mdsanima][badge-11]][link-10]
[![twitter-follow-toudajew][badge-12]][link-12]
[![twitter-follow-str9led][badge-13]][link-13]
[![twitter-follow-mdsanima][badge-14]][link-14]

[![subreddit-subscribers-mdsanima][badge-15]][link-15]
[![youtube-subscribers-mdsanima][badge-16]][link-16]
[![youtube-views-mdsanima][badge-17]][link-16]
[![twitch-status-mdsanima][badge-18]][link-17]
[![discord-chat-mdsanima][badge-19]][link-09]

## License

Python package [mdsanima-dev][link-02] developed by [Marcin Różewski][link-10] is released under the terms of
[MIT License][link-11]

[badge-pe]: https://static.pepy.tech/personalized-badge/mdsanima-dev?period=total&units=none&left_color=grey&right_color=yellowgreen&left_text=downloads
[badge-01]: https://img.shields.io/github/license/mdsanima-dev/mdsanima-dev?style=flat
[badge-02]: https://img.shields.io/pypi/v/mdsanima-dev?style=flat&logo=pypi&logoColor=lightgray
[badge-03]: https://img.shields.io/github/languages/top/mdsanima-dev/mdsanima-dev?style=flat&logo=python&logoColor=lightgray
[badge-04]: https://img.shields.io/pypi/pyversions/mdsanima-dev?style=flat&logo=python&logoColor=lightgray
[badge-05]: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=lightgray
[badge-06]: https://img.shields.io/github/stars/mdsanima-dev/mdsanima-dev?style=flat&logo=github
[badge-07]: https://img.shields.io/github/issues-raw/mdsanima-dev/mdsanima-dev?style=flat&logo=github
[badge-08]: https://img.shields.io/github/issues-closed-raw/mdsanima-dev/mdsanima-dev?style=flat&logo=github
[badge-09]: https://img.shields.io/github/deployments/mdsanima-dev/mdsanima-dev/github-pages?style=flat&logo=github
[badge-10]: https://img.shields.io/website?url=https%3A%2F%2Fmdsanima-dev.github.io%2Fmdsanima-dev%2F?style=flat&logo=github
[badge-11]: https://img.shields.io/github/followers/mdsanima?style=social
[badge-12]: https://img.shields.io/twitter/follow/toudajew?style=social
[badge-13]: https://img.shields.io/twitter/follow/str9led?style=social
[badge-14]: https://img.shields.io/twitter/follow/mdsanima?style=social
[badge-15]: https://img.shields.io/reddit/subreddit-subscribers/mdsanima?style=social
[badge-16]: https://img.shields.io/youtube/channel/subscribers/UCB5na2BRwrnwx00LCspbG5Q?style=social
[badge-17]: https://img.shields.io/youtube/channel/views/UCB5na2BRwrnwx00LCspbG5Q?style=social
[badge-18]: https://img.shields.io/twitch/status/mdsanima?style=social
[badge-19]: https://img.shields.io/discord/621477380359454742?style=social&logo=discord
[link-01]: https://github.com/mdsanima-dev/mdsanima-dev
[link-02]: https://pypi.org/project/mdsanima-dev
[link-03]: https://github.com/psf/black
[link-04]: https://pepy.tech/project/mdsanima-dev
[link-05]: https://github.com/mdsanima-dev/mdsanima-dev/issues?q=is%3Aopen+is%3Aissue
[link-06]: https://github.com/mdsanima-dev/mdsanima-dev/issues?q=is%3Aissue+is%3Aclosed
[link-07]: https://github.com/mdsanima-dev/mdsanima-dev/deployments/activity_log?environment=github-pages
[link-08]: https://mdsanima-dev.github.io/mdsanima-dev/
[link-09]: https://discord.gg/c3m7pTF
[link-10]: https://github.com/mdsanima
[link-11]: https://github.com/mdsanima-dev/mdsanima-dev/blob/master/LICENSE
[link-12]: https://twitter.com/intent/follow?toudajew&screen_name=toudajew
[link-13]: https://twitter.com/intent/follow?str9led&screen_name=str9led
[link-14]: https://twitter.com/intent/follow?mdsanima&screen_name=mdsanima
[link-15]: https://reddit.com/r/mdsanima/
[link-16]: https://youtube.com/mdsanima?sub_confirmation=1
[link-17]: https://twitch.tv/mdsanima/

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "mdsanima-dev",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "animation,automatic,bash,changelog,cli,colors,command-line,console-app,console-application,console,development,emoj,mdsanima-dev,mdsanima,python-library,python,python3,shell-script,shell,terminal,tools,versioning,vfx,zsh",
    "author": "",
    "author_email": "Marcin R\u00f3\u017cewski <marcinrozewski@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/44/1a/a2bb1099482d66eb6c25dc1053b381824791c67141ff5c2f02fac2d50837/mdsanima_dev-0.2.0.tar.gz",
    "platform": null,
    "description": "# mdsanima-dev\n\n[![license-mdsanima][badge-01]][link-01]\n[![latest-version-on-pypi][badge-02]][link-02]\n[![github-top-language][badge-03]][link-01]\n[![pypi-python-version][badge-04]][link-02]\n[![code-style-black][badge-05]][link-03]\n\n[![pype-total-downloads][badge-pe]][link-04]\n[![github-repo-stars][badge-06]][link-01]\n[![github-open-issues][badge-07]][link-05]\n[![github-closed-issues][badge-08]][link-06]\n[![github-deployments][badge-09]][link-07]\n[![github-pages-documentation][badge-10]][link-08]\n\n_Python_ package [mdsanima-dev][link-02] is for colorizing, adding emoji and making table on console shell print output.\nYou can find here _Python_ modules that's make coding easier and cooler, includes several useful modules that we're use\nin various projects. In the future we're add more cool function on this package.\n\nDocomentation available at [GitHub Pages][link-08], be sure to check it.\n\n## Installation `Options`\n\nInstructions how to install the _Python_ package [mdsanima-dev][link-02] on your system.\n\n<!-- start help-installation -->\n\nOptions [PyPI](#using-pypi) allows you to install the package **globally** on your system. If you want to install the\npackage in an **isolated environment** on your system use the [virtualenv](#using-virtualenv) options.\n\n<!-- end help-installation -->\n\n### Using `PyPI`\n\n<!-- start help-using-pypi -->\n\nInstall latest version:\n\n```shell\npython3 -m pip install mdsanima-dev\n```\n\nInstall specific version:\n\n```shell\npython3 -m pip install mdsanima-dev==0.2.0\n```\n\nUpgrade package to latest version:\n\n```shell\npython3 -m pip install --upgrade mdsanima-dev\n```\n\nReinstall package to latest version:\n\n```shell\npython3 -m pip install --force-reinstall msdsanima-dev\n```\n\nUninstall package:\n\n```shell\npython3 -m pip uninstall mdsanima-dev\n```\n\n<!-- end help-using-pypi -->\n\n### Using `virtualenv`\n\n<!-- start help-on-virtualenv -->\n\nClone repository with all number of commits history using HTTPS:\n\n```shell\ngit clone https://github.com/mdsanima-dev/mdsanima-dev.git\n```\n\nClone repository with the specified number of commits history using SSH:\n\n```shell\ngit clone --depth=1 git@github.com:mdsanima-dev/mdsanima-dev.git\n```\n\nThen go to the repository directory:\n\n```shell\ncd mdsanima-dev\n```\n\nCreate isolated environment with specific package version then activate and install requirements, type in terminal:\n\n```shell\nvirtualenv --setuptools 67.7.2 --wheel 0.40.0 --pip 23.1.2 .venv\nsource .venv/bin/activate\npip install -r requirements-dev.txt\npip install -r requirements-doc.txt\n```\n\nInstall build tools for creating distribution, then build package from source, type in terminal:\n\n```shell\npip install --upgrade build\npython -m build\n```\n\nFinnaly install the package in virtual environment, type in the terminal:\n\n```shell\npip install --force-reinstall dist/mdsanima_dev-0.2.0-py3-none-any.whl\n```\n\nIn this case I used the `--force-reinstall` option because I had an earlier version of this package already installed.\n\nAlso you can build Sphinx documentation, type in terminal:\n\n```shell\npython setup.py build_sphinx\ncd build/dirhtml\npython -m http.server 8080\n```\n\nNow open [localhost](http://localhost:8080) to see the documentation.\n\nDeactivate virtual environment, type in the terminal:\n\n```shell\ndeactivate\n```\n\n<!-- end help-on-virtualenv -->\n\n## Develempent\n\nInstruction for the _Python_ package development. Please check the [documentation][link-08] site for more information.\n\n## Showcase\n\n![mdsanima-dev-python-show](docs/_images/gif/mdsanima_dev_python_show.gif)\n\n## Follow Me\n\nThese are my social media account, be sure to check it. Thanks!\n\n[![github-followers-mdsanima][badge-11]][link-10]\n[![twitter-follow-toudajew][badge-12]][link-12]\n[![twitter-follow-str9led][badge-13]][link-13]\n[![twitter-follow-mdsanima][badge-14]][link-14]\n\n[![subreddit-subscribers-mdsanima][badge-15]][link-15]\n[![youtube-subscribers-mdsanima][badge-16]][link-16]\n[![youtube-views-mdsanima][badge-17]][link-16]\n[![twitch-status-mdsanima][badge-18]][link-17]\n[![discord-chat-mdsanima][badge-19]][link-09]\n\n## License\n\nPython package [mdsanima-dev][link-02] developed by [Marcin R\u00f3\u017cewski][link-10] is released under the terms of\n[MIT License][link-11]\n\n[badge-pe]: https://static.pepy.tech/personalized-badge/mdsanima-dev?period=total&units=none&left_color=grey&right_color=yellowgreen&left_text=downloads\n[badge-01]: https://img.shields.io/github/license/mdsanima-dev/mdsanima-dev?style=flat\n[badge-02]: https://img.shields.io/pypi/v/mdsanima-dev?style=flat&logo=pypi&logoColor=lightgray\n[badge-03]: https://img.shields.io/github/languages/top/mdsanima-dev/mdsanima-dev?style=flat&logo=python&logoColor=lightgray\n[badge-04]: https://img.shields.io/pypi/pyversions/mdsanima-dev?style=flat&logo=python&logoColor=lightgray\n[badge-05]: https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=lightgray\n[badge-06]: https://img.shields.io/github/stars/mdsanima-dev/mdsanima-dev?style=flat&logo=github\n[badge-07]: https://img.shields.io/github/issues-raw/mdsanima-dev/mdsanima-dev?style=flat&logo=github\n[badge-08]: https://img.shields.io/github/issues-closed-raw/mdsanima-dev/mdsanima-dev?style=flat&logo=github\n[badge-09]: https://img.shields.io/github/deployments/mdsanima-dev/mdsanima-dev/github-pages?style=flat&logo=github\n[badge-10]: https://img.shields.io/website?url=https%3A%2F%2Fmdsanima-dev.github.io%2Fmdsanima-dev%2F?style=flat&logo=github\n[badge-11]: https://img.shields.io/github/followers/mdsanima?style=social\n[badge-12]: https://img.shields.io/twitter/follow/toudajew?style=social\n[badge-13]: https://img.shields.io/twitter/follow/str9led?style=social\n[badge-14]: https://img.shields.io/twitter/follow/mdsanima?style=social\n[badge-15]: https://img.shields.io/reddit/subreddit-subscribers/mdsanima?style=social\n[badge-16]: https://img.shields.io/youtube/channel/subscribers/UCB5na2BRwrnwx00LCspbG5Q?style=social\n[badge-17]: https://img.shields.io/youtube/channel/views/UCB5na2BRwrnwx00LCspbG5Q?style=social\n[badge-18]: https://img.shields.io/twitch/status/mdsanima?style=social\n[badge-19]: https://img.shields.io/discord/621477380359454742?style=social&logo=discord\n[link-01]: https://github.com/mdsanima-dev/mdsanima-dev\n[link-02]: https://pypi.org/project/mdsanima-dev\n[link-03]: https://github.com/psf/black\n[link-04]: https://pepy.tech/project/mdsanima-dev\n[link-05]: https://github.com/mdsanima-dev/mdsanima-dev/issues?q=is%3Aopen+is%3Aissue\n[link-06]: https://github.com/mdsanima-dev/mdsanima-dev/issues?q=is%3Aissue+is%3Aclosed\n[link-07]: https://github.com/mdsanima-dev/mdsanima-dev/deployments/activity_log?environment=github-pages\n[link-08]: https://mdsanima-dev.github.io/mdsanima-dev/\n[link-09]: https://discord.gg/c3m7pTF\n[link-10]: https://github.com/mdsanima\n[link-11]: https://github.com/mdsanima-dev/mdsanima-dev/blob/master/LICENSE\n[link-12]: https://twitter.com/intent/follow?toudajew&screen_name=toudajew\n[link-13]: https://twitter.com/intent/follow?str9led&screen_name=str9led\n[link-14]: https://twitter.com/intent/follow?mdsanima&screen_name=mdsanima\n[link-15]: https://reddit.com/r/mdsanima/\n[link-16]: https://youtube.com/mdsanima?sub_confirmation=1\n[link-17]: https://twitch.tv/mdsanima/\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2021 - 2022 Marcin R\u00f3\u017cewski <marcinrozewski@gmail.com>  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "MDSANIMA-DEV Python Development Tools",
    "version": "0.2.0",
    "project_urls": {
        "changelog": "https://github.com/mdsanima-dev/mdsanima-dev/blob/main/CHANGELOG.md",
        "documentation": "https://github.com/mdsanima-dev/mdsanima-dev#readme",
        "homepage": "https://github.com/mdsanima-dev/mdsanima-dev",
        "repository": "https://github.com/mdsanima-dev/mdsanima-dev.git"
    },
    "split_keywords": [
        "animation",
        "automatic",
        "bash",
        "changelog",
        "cli",
        "colors",
        "command-line",
        "console-app",
        "console-application",
        "console",
        "development",
        "emoj",
        "mdsanima-dev",
        "mdsanima",
        "python-library",
        "python",
        "python3",
        "shell-script",
        "shell",
        "terminal",
        "tools",
        "versioning",
        "vfx",
        "zsh"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9ffcce5ada3c00770b4f3e614ab45c4243b2d74ef974643fadb62f0f6009a9dc",
                "md5": "4c5de1a57f8d8c7f5329708d473ddee6",
                "sha256": "4caae97667d1fc5bbd99ef61b84a8bf4f58ce9c3949fd0072d4e6f0fe3444a2d"
            },
            "downloads": -1,
            "filename": "mdsanima_dev-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4c5de1a57f8d8c7f5329708d473ddee6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 68655,
            "upload_time": "2023-05-12T10:03:20",
            "upload_time_iso_8601": "2023-05-12T10:03:20.889123Z",
            "url": "https://files.pythonhosted.org/packages/9f/fc/ce5ada3c00770b4f3e614ab45c4243b2d74ef974643fadb62f0f6009a9dc/mdsanima_dev-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "441aa2bb1099482d66eb6c25dc1053b381824791c67141ff5c2f02fac2d50837",
                "md5": "26801be20de2b3bf2964f225c8f5dbc8",
                "sha256": "96684e1a03c7f709351318b9e9f75b688e037769d967ef51a124021cdd8ca439"
            },
            "downloads": -1,
            "filename": "mdsanima_dev-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "26801be20de2b3bf2964f225c8f5dbc8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 34468001,
            "upload_time": "2023-05-12T10:06:48",
            "upload_time_iso_8601": "2023-05-12T10:06:48.854819Z",
            "url": "https://files.pythonhosted.org/packages/44/1a/a2bb1099482d66eb6c25dc1053b381824791c67141ff5c2f02fac2d50837/mdsanima_dev-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-12 10:06:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mdsanima-dev",
    "github_project": "mdsanima-dev",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mdsanima-dev"
}
Elapsed time: 0.07612s