Skip to content

Commit ba5f81f

Browse files
Update README, inited pypi package
1 parent ac52a8a commit ba5f81f

File tree

3 files changed

+54
-3
lines changed

3 files changed

+54
-3
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
venv
22
/venv/
3-
__pycache__
3+
__pycache__
4+
/build/
5+
/dist/
6+
/adjustable_random_package.egg-info/

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,52 @@ final array will look like this:
1313
```
1414

1515
and chance of random.choice for those values
16-
will be increased
16+
will be increased
17+
18+
# Examples
19+
20+
### Run basic functions
21+
22+
```
23+
from adjustable_random import (
24+
get_adjustable_random_list,
25+
get_adjustable_random_value
26+
)
27+
28+
if __name__ == '__main__':
29+
30+
adjustable_list: list[int] = get_adjustable_random_list(
31+
min_value=0,
32+
max_value=100,
33+
numbers_to_adjust=[
34+
10,15
35+
]
36+
)
37+
adjustable_value: int = get_adjustable_random_value(
38+
min_value=0,
39+
max_value=100,
40+
numbers_to_adjust=[
41+
10,15
42+
]
43+
)
44+
45+
print(f"{adjustable_list=}")
46+
print(f"{adjustable_value=}")
47+
48+
```
49+
50+
51+
### Run tests to see how it works
52+
53+
54+
```
55+
from adjustable_random import (
56+
init_random_values,
57+
run_graph_test
58+
)
59+
60+
if __name__ == '__main__':
61+
values: list[int] = init_random_values()
62+
run_graph_test(values)
63+
64+
```

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="adjustable_random package",
8-
version="1.0",
8+
version="1.1",
99
author="dinosaurtirex",
1010
author_email="[email protected]",
1111
packages=[

0 commit comments

Comments
 (0)