1
1
# Python Algorithms & Data Structures
2
2
3
+ [ ![ python] [ 19 ]] [ 20 ]
4
+ [ ![ license MIT] [ 9 ]] [ 10 ]
3
5
[ ![ linux build & tests] [ 13 ]] [ 14 ]
4
6
[ ![ codeql] [ 15 ]] [ 16 ]
5
7
6
- [ ![ python] [ 19 ]] [ 20 ]
7
- [ ![ dependabot] [ 21 ]] [ 22 ]
8
-
9
- [ ![ license MIT] [ 9 ]] [ 10 ]
10
8
[ ![ style black] [ 11 ]] [ 12 ]
11
9
[ ![ lint: flake8] [ 1 ]] [ 2 ]
12
10
[ ![ test: pytest] [ 3 ]] [ 4 ]
@@ -20,14 +18,24 @@ Algorithms and data structures implemented in Python. Here you'll find:
20
18
21
19
## Installation
22
20
23
- To install the project dependencies, you can either use [ poetry] [ 80 ] and
24
- ` poetry install ` (recommended), or install the dependencies globally and manually using
25
- ` pip install <dependencies> ` and the dependency list in ` pyproject.toml ` .
21
+ With [ poetry] [ 80 ] :
26
22
27
23
``` bash
28
24
git clone https://github.com/JCPedroza/algorithms-and-data-structures-py.git
29
25
cd algorithms-and-data-strcutrues-py
30
- poetry install # Install all packages in the local virtual environment
26
+ poetry install
27
+ ```
28
+
29
+ With [ venv] [ 87 ] and [ pip] [ 86 ] :
30
+
31
+ ``` bash
32
+ mkdir ads
33
+ cd ads
34
+ python -m venv venv-ads
35
+ source source venv-ads/bin/activate
36
+ git clone https://github.com/JCPedroza/algorithms-and-data-structures-py.gitcd
37
+ cd algorithms-and-data-strcutrues-py
38
+ python -m pip install . # The dot is needed
31
39
```
32
40
33
41
## Unit Testing
@@ -71,6 +79,15 @@ Code reviews, pull requests, issues, and discussions are always welcome!
71
79
- [ flake8] [ 83 ]
72
80
- [ black] [ 85 ]
73
81
82
+ ## Contributing
83
+
84
+ Found a bug, typo, or mistake? Want to refactor, optimize, or improve something in this
85
+ repository? ** Send a pull request! Pull requests are always welcome!**
86
+
87
+ There's no need to create an issue. Just use a descriptive commit message and I'll
88
+ format it adequately when accepting the pull request. Contributing here is as simple
89
+ as commiting your changes and sending a pull request!
90
+
74
91
---
75
92
76
93
[ ![ code size] [ 53 ]] [ 54 ]
@@ -124,8 +141,5 @@ Code reviews, pull requests, issues, and discussions are always welcome!
124
141
[ 83 ] : https://flake8.pycqa.org/
125
142
[ 84 ] : https://prospector.landscape.io/en/master/
126
143
[ 85 ] : https://black.readthedocs.io/en/stable/the_black_code_style/index.html
127
-
128
- [ 101 ] : https://github.com/JCPedroza/algorithms-and-data-structures-js
129
- [ 102 ] : https://github.com/JCPedroza/algorithms-and-data-structures-ocaml
130
- [ 103 ] : https://github.com/JCPedroza/algorithms-and-data-structures-hs
131
- [ 104 ] : https://github.com/JCPedroza/algorithms-and-data-structures-sml
144
+ [ 86 ] : https://github.com/pypa/pip
145
+ [ 87 ] : https://docs.python.org/3/library/venv.html
0 commit comments