11# Python Algorithms & Data Structures
22
3+ [ ![ python] [ 19 ]] [ 20 ]
4+ [ ![ license MIT] [ 9 ]] [ 10 ]
35[ ![ linux build & tests] [ 13 ]] [ 14 ]
46[ ![ codeql] [ 15 ]] [ 16 ]
57
6- [ ![ python] [ 19 ]] [ 20 ]
7- [ ![ dependabot] [ 21 ]] [ 22 ]
8-
9- [ ![ license MIT] [ 9 ]] [ 10 ]
108[ ![ style black] [ 11 ]] [ 12 ]
119[ ![ lint: flake8] [ 1 ]] [ 2 ]
1210[ ![ test: pytest] [ 3 ]] [ 4 ]
@@ -20,14 +18,24 @@ Algorithms and data structures implemented in Python. Here you'll find:
2018
2119## Installation
2220
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 ] :
2622
2723``` bash
2824git clone https://github.com/JCPedroza/algorithms-and-data-structures-py.git
2925cd 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
3139```
3240
3341## Unit Testing
@@ -71,6 +79,15 @@ Code reviews, pull requests, issues, and discussions are always welcome!
7179 - [ flake8] [ 83 ]
7280 - [ black] [ 85 ]
7381
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+
7491---
7592
7693[ ![ code size] [ 53 ]] [ 54 ]
@@ -124,8 +141,5 @@ Code reviews, pull requests, issues, and discussions are always welcome!
124141[ 83 ] : https://flake8.pycqa.org/
125142[ 84 ] : https://prospector.landscape.io/en/master/
126143[ 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