@@ -18,52 +18,61 @@ Algorithms and data structures implemented in Python. Here you'll find:
18
18
19
19
## Installation
20
20
21
- With [ poetry] [ 80 ] :
21
+ ### With [ poetry] [ 80 ] :
22
22
23
23
``` bash
24
+ # Get repository
24
25
git clone https://github.com/JCPedroza/algorithms-and-data-structures-py.git
25
26
cd algorithms-and-data-strcutrues-py
26
- poetry install
27
+
28
+ # Install dependencies in local virtual environment
29
+ poetry install # Without a dot as argument
27
30
```
28
31
29
- With [ venv] [ 87 ] and [ pip] [ 86 ] :
32
+ ### With [ venv] [ 87 ] and [ pip] [ 86 ] :
30
33
31
34
``` bash
32
- mkdir ads
33
- cd ads
34
- python -m venv venv-ads
35
- source source venv-ads/bin/activate
35
+ # Create project directory
36
+ mkdir algos-and-data # Need a dir for env files
37
+ cd algos-and-data
38
+
39
+ # Create and activate local virtual environment
40
+ python -m venv venv-algos-and-data # Create local virtual environment
41
+ source venv-ads/bin/activate # Activate local virtual environment
42
+
43
+ # Get repository
36
44
git clone https://github.com/JCPedroza/algorithms-and-data-structures-py.git
37
45
cd algorithms-and-data-strcutrues-py
38
- python -m pip install . # The dot is needed
46
+
47
+ # Install dependencies in local virtual environment
48
+ python -m pip install . # The dot is required
39
49
```
40
50
41
51
## Unit Testing
42
52
53
+ ### With [ poetry] [ 80 ] :
54
+
43
55
``` bash
44
- poetry run pytest # Run al unit tests using local virtual environment
56
+ poetry run pytest # Run al unit tests using local virtual environment
45
57
```
46
58
47
- ## Other Poetry Commands
59
+ ### With [ venv] [ 87 ] and [ pip] [ 86 ] :
60
+
61
+ With the local virtual environment activated:
48
62
49
63
``` bash
50
- poetry shell # Activate shell inside local virtual environment
51
- poetry run < command> # Run command inside local virtual environment
52
- poetry check # Validate structure of pyproject.toml
64
+ python -m pytest # With or without dot as argument
53
65
```
54
66
55
- ## Contributing
67
+ ## Important Poetry Commands
56
68
57
- [ ![ contributors] [ 25 ]] [ 26 ]
58
- [ ![ commit activity] [ 27 ]] [ 28 ]
59
- [ ![ issues] [ 29 ]] [ 30 ]
60
- [ ![ issues closed] [ 31 ]] [ 32 ]
61
- [ ![ issues pr] [ 33 ]] [ 34 ]
62
- [ ![ issues pr closed] [ 35 ]] [ 36 ]
63
-
64
- Code reviews, pull requests, issues, and discussions are always welcome!
69
+ ``` bash
70
+ poetry run < command> # Run command inside local virtual environment
71
+ poetry shell # Activate shell inside local virtual environment
72
+ poetry check # Validate structure of pyproject.toml
73
+ ```
65
74
66
- ## Main Toolchain
75
+ ## Toolchain Overview
67
76
68
77
- Package manager
69
78
- [ poetry] [ 80 ]
@@ -81,6 +90,13 @@ Code reviews, pull requests, issues, and discussions are always welcome!
81
90
82
91
## Contributing
83
92
93
+ [ ![ contributors] [ 25 ]] [ 26 ]
94
+ [ ![ commit activity] [ 27 ]] [ 28 ]
95
+ [ ![ issues] [ 29 ]] [ 30 ]
96
+ [ ![ issues closed] [ 31 ]] [ 32 ]
97
+ [ ![ issues pr] [ 33 ]] [ 34 ]
98
+ [ ![ issues pr closed] [ 35 ]] [ 36 ]
99
+
84
100
Found a bug, typo, or mistake? Want to refactor, optimize, or improve something in this
85
101
repository? ** Send a pull request! Pull requests are always welcome!**
86
102
0 commit comments