Skip to content

Commit

Permalink
docs: addin new links and badge layouts closes #16
Browse files Browse the repository at this point in the history
removing badge total line on `README.md` file and probably wrinte
new page to show all badge in documentation site closes #17
  • Loading branch information
mdsanima committed Apr 12, 2022
1 parent 38313dc commit 28a39db
Showing 1 changed file with 188 additions and 50 deletions.
238 changes: 188 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,51 @@
# mdsanima-dev

![GitHub issues](https://img.shields.io/github/issues-raw/mdsanima-dev/mdsanima-dev?style=flat)
![GitHub closed issues](https://img.shields.io/github/issues-closed/mdsanima-dev/mdsanima-dev?style=flat)
![GitHub](https://img.shields.io/github/license/mdsanima-dev/mdsanima-dev?style=flat)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mdsanima-dev?style=flat)
![Lines of code](https://img.shields.io/tokei/lines/github/mdsanima-dev/mdsanima-dev?style=flat)
![GitHub top language](https://img.shields.io/github/languages/top/mdsanima-dev/mdsanima-dev)
[![Downloads](https://pepy.tech/badge/mdsanima-dev)](https://pepy.tech/project/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]

This is a **mdsanima-dev** developer page. Here you can find various python
modules. So let me show something.
[![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`
<!-- start info-mdsanima-dev -->

This Python Pacage developed by Marcin Różewski aka
[MDSANIM](https://mdsanima.com) includes several useful modules thats he uses
in various projects. Docomentation for **mdsanima-dev** Python Package
is available at [docs mdsanima-dev](https://mdsanima-dev.github.io/mdsanima-dev/)
be sure to check it.
*Python* package [`mdsanima-dev`](https://pypi.org/project/mdsanima-dev) 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 use in various projects.
Also, in the future we're add more cool function on this package.

<!-- end info-mdsanima-dev -->

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

## Installation

Instructions how to install the package.
<!-- start help-started -->

Instructions how to install the *Python* package
[`mdsanima-dev`](https://pypi.org/project/mdsanima-dev) on your system.

<!-- end help-started -->

<!-- start help-installation -->

Options [`PyPI`](#using-pypi), [`Setup`](#using-setup) or
[`Wheel`](#using-wheel) 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`](#on-virtualenv) options.

<!-- end help-installation -->

### Using PyPi
### Using `PyPI`

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

Install latest version:

Expand All @@ -34,80 +56,196 @@ python3 -m pip install mdsanima-dev
Install specific version:

```shell
python3 -m pip install mdsanima-dev==0.1.0
python3 -m pip install mdsanima-dev==0.1.1
```

Upgrade pacage to latest version:
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 pacage:
Uninstall package:

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

### Using Setup
<!-- end help-using-pypi -->

### Using `Setup`

<!-- start help-using-setup -->

Install the package using `easy install` options, but this is an deprecated
method and not recommend using this, instead of this method please use
[`Wheel`](#using-wheel) options for install.

Clone repository with all number of commits history using HTTPS:

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

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 `cd mdsanima-dev` and install the package:

```shell
python3 setup.py install
```

## Develempent
<!-- end help-using-setup -->

### Using `Wheel`

Help instruction for development. Check [documentation](https://mdsanima-dev.github.io/mdsanima-dev/html/development.html)
for workflow release and more info.
<!-- start help-using-wheel -->

### Build documentation
Build package from source then install it. Clone the repository just like in
the [`Using Setup`](#using-setup) statement then type in the terminal:

```shell
sudo python3 setup.py install build_sphinx
python3 setup.py sdist bdist_wheel
```

### Automation Release
The package build creates new directories where the installation files are
located the `build` and `dist` directories. Then install the package just like
in the [`Using PyPI`](#using-pypi) statement, but instead of entering the
package name, give the path to the `.whl` file that was built earlier:

Add a `standard-version` npm pacage to automatically create `CHANGELOG.md`
and tracking version. This option allow to generate automatically changelog
file for the project and tracking version on the `mdsanima_dev` based on commit
messages.
```shell
python3 -m pip install --force-reinstall dist/mdsanima_dev-0.1.1-py3-none-any.whl
```

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

<!-- end help-using-wheel -->

### On `virtualenv`

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

Create virtual environment in hidden folder, type in the terminal:

```shell
virtualenv .venv
```

Activate virtual environment in hidden folder, type in the terminal:

```shell
source .venv/bin/activate
```

For some reason thats features is only for the development not allow and accecs
for the `mdsanima_dev` Python Pacage.
If you want to create virtual environment with specific *Python* version, type
in the terminal:

Make release run in the console:
```shell
virtualenv venv39 -p python3.9
```

Activate virtual environment with specific *Python* version, type in the
terminal:

```shell
standard-version release
source venv39/bin/activate
```

For checking if everything is ok:
Finnaly install the package in virtual environment, type in the terminal:

```shell
standard-version release-test
pip install mdsanima-dev
```

Also you can use [`PyPI`](#using-pypi), [`Setup`](#using-setup) or
[`Wheel`](#using-wheel) options.

Deactivate virtual environment, type in the terminal:

```shell
deactivate
```

You can use also [`venv`](https://docs.python.org/3/tutorial/venv.html) instead
of this option.

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

## Develempent

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

## Showcase

![python_mdsanima_dev_small_fast](https://user-images.githubusercontent.com/3817871/129311978-e934ab26-85d9-49a1-97a7-dd5eb26b2c72.gif)
![mdsanima-dev-python-show](docs/_images/gif/mdsanima_dev_python_show.gif)

## Connect With Me
## Follow Me

Hi there, I'm Marcin Różewski aka [MDSANIMA](https://mdsanima.com).
These are my social media, check it out please. Thanks.
These are my social media account, be sure to check it. Thanks!

![GitHub followers](https://img.shields.io/github/followers/mdsanima?style=social)
![Twitter Follow](https://img.shields.io/twitter/follow/toudajew?style=flat-square)
![Twitter Follow](https://img.shields.io/twitter/follow/str9led?style=flat-square)
![Twitter Follow](https://img.shields.io/twitter/follow/mdsanima?style=flat-square)
![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCB5na2BRwrnwx00LCspbG5Q?style=social)
![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCB5na2BRwrnwx00LCspbG5Q?style=social)
[![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 Pacage `mdsanima_dev` is released under the terms of
[MIT License](https://github.com/mdsanima-dev/mdsanima-dev/blob/master/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/

0 comments on commit 28a39db

Please sign in to comment.