Metadata-Version: 2.1
Name: cd_randomizer
Version: 0.0.2
Summary: A simple CD randomizer package.
Author-email: Nicholas Capasso <codedocta@gmail.com>
License: MIT License
        
        Copyright (c) 2023 Code Docta Media; Nicholas Capasso
        
        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.
        
Project-URL: Home, https://github.com/codedocta/cd_randomizer
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: LICENSE.txt


# cd_randomizer

`cd_randomizer` is a Python package for randomizing CDs.

## Installation

You can install `cd_randomizer` using pip:

```bash
pip install cd_randomizer
```

## Usage

Here is a simple example of how to use `cd_randomizer`:

```python
from cd_randomizer.rand import Randomizer as rando

a_list = [1,2,3,4,5]

# Example usage
item = rando.random_list_item(a_list)
print("random item", item)

rando.randomize_list(a_list) # it will shuffle in place, no nee to make another list
print(a_list)

decimal = rando.random_decimal(2.50005, 4.0, round_to=3)
print("random decimal(float)", decimal)

list_item = rando.random_list_item(a_list)
print("random list item", list_item)

rand_number = rando.random_number(1, 100)
print("Random whole number between 1 and 100", rand_number)

rand_items = rando.random_sample_of_a_list(a_list, 3)
print("3 random list items", rand_items)
```

## Examples

For more examples, please refer to the `examples` folder.

## Contributing

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

## More documentation at:
[Code Docta](https://codedocta.com "Code Docta")

## License

[MIT](https://choosealicense.com/licenses/mit/)
