![###carnival-toolbox###][header-picture-logo]

![GitHub package.json version (branch)](https://img.shields.io/github/package-json/v/sarverott/carnival-toolbox/master?label=package.json%20version)
![Dependents (via libraries.io)](https://img.shields.io/librariesio/dependents/npm/carnival-toolbox?&logo=npm&logoColor=%23ff4455&label=NPM%20dependents&labelColor=%23ffeedd&color=%23ff4455&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fcarnival-toolbox)
![npm downloads](https://img.shields.io/npm/dt/carnival-toolbox?logo=npm&logoColor=%23ff4455&label=NPM%20package%20downloads&labelColor=%23ffeedd&color=%23ff4455&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fcarnival-toolbox)
[![Documentation Status](https://readthedocs.org/projects/carnival-toolbox/badge/?version=latest)](https://carnival-toolbox.readthedocs.io/en/latest/?badge=latest)


# IT'S HERE AND IN NPM PACKAGE MANAGER NOW
Some of simple and usefull functions,
just another remix of common functions
from out of standard scope, but with good
quality of taking care on user
and easy-to-use intuitive namespaces.
> It's my first package in npm library, so partly
> it's training, but with reasonable contribution
> of something usefull.

---

#### install by NPM
```sh
  npm install carnival-toolbox
```
#### and then use in code
```javascript
  //classic cjs style
  const crnTbx = require('carnival-toolbox');
  //modern ecma style
  import * from "carnival-toolbox"
  //coffeescript style
  require "carnival-toolbox"
  //use wisely as you like by your way
```
#### but if just alternatively clone repo you want
```
  git clone https://github.com/Sarverott/carnival-toolbox.git
```
#### or install as git submodule in your repo
```
  git submodule add https://github.com/Sarverott/carnival-toolbox.git
```

feel free to do what you desire, until you respects terms of license _(see ["LICENSE" file](./LICENSE) for more information)_.

---

#### testing, experiments, view of behaviour
need some practical presentation and experience what it is? invoke it, using node in console and take it on testride:

```sh
  # from thesame as install path
  # after installation by npm
  node ./node_modules/carnival-toolbox/_index.js
  # after clone, or submodule adding
  cd carnival-toolbox && npm start
  # it can shock you if by looking on my other
  # work you compare it with this CLI... experiments makes work funier!
```

## FOR DEVELOPERS
There are some cool lifehacks for creators. OS-dedicated `QUICKSTART`
scripts will guide you through boring and required stuff.

```sh
  #developers needs some extra python and node packages
  #quick lounchers will make everything what is needed
  #for windows users
  npm run DEV.windows
  #for linux users
  npm run DEV.linux
  #for android users
  npm run DEV.android
  #for MacOS users
  npm run DEV.macintosh
  #this reminder will be shown,
  #when you lounch "npm run DEV",
  #but because it can't automaticaly detect os and shell
  #you have to make it by hand

```

---

### functionality list
- random password generation - **password stuff**
- finding prime numbers - **exercises with cryptography**
- fibonacci set - **exercises with cryptography**
- case gadgets - **namespace's case converter**
- PLT & TLP - **examples of custom cryptography exercise**
- json gadgets - **simplified json reader**

### links related
- __GitHub repo__ - https://github.com/Sarverott/carnival-toolbox
- __NPM.com repo__ - https://www.npmjs.com/package/carnival-toolbox
- __Project's developement roadmap__ - https://github.com/users/Sarverott/projects/16?fullscreen=true

> Copyright (c) 2022 Sett Sarverott <sarverott@gmail.com> released on terms of MIT license

[header-picture-logo]: https://64.media.tumblr.com/14cb2c2a576ab5cd1cefcd2ec5a2fe5e/6731a5ed7242f36a-40/s1280x1920/1024d02a13283e30c1c4fae123ee8d05ce6dd8b8.pnj