Skip to content

Commit 47821f8

Browse files
authored
docs: improove init project README
1 parent a67cbc2 commit 47821f8

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

README.md

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,71 @@
1-
# python-challenges
1+
## 🧩 Python Challenges 🐍
2+
3+
A collection of my **python coding challenges** and practice **exercises**, focusing on **problem solving**, **data structures**, and **algorithms**.
4+
5+
---
6+
7+
### Contents
8+
- [**Advent of Code** 🎄](https://github.com/aleattene/python-challenges/tree/main/advent_of_code)
9+
- [**Everybody Codes** 🧠](https://github.com/aleattene/python-challenges/tree/main/everybody-codes)
10+
- [**Codewars** ⚔️](https://github.com/aleattene/python-challenges/tree/main/codewars)
11+
- [**Edabit** 🎯](https://github.com/aleattene/python-challenges/tree/main/edabit)
12+
- [**Python Workbook** 📓](https://github.com/aleattene/python-challenges/tree/main/learning/python-workbook)
13+
14+
---
15+
16+
### Quickstart
17+
**1) Clone and enter the repo**
18+
```bash
19+
git clone https://github.com/aleattene/python-challenges.git
20+
cd python-challenges
21+
```
22+
23+
**2) (optional) create & activate a virtual environment**
24+
```bash
25+
python -m venv env_name
26+
(mac) source env_name/bin/activate
27+
(win) env_name\Scripts\activate
28+
```
29+
30+
**3) Install dependencies**
31+
```bash
32+
pip install -U pip
33+
pip install -r requirements.txt
34+
```
35+
36+
**4) Run all tests**
37+
```bash
38+
pytest -q
39+
```
40+
41+
**or run tests for a specific area**
42+
```bash
43+
# Advent of Code
44+
pytest advent-of-code -q
45+
46+
# Everybody Codes
47+
pytest everybody_codes -q
48+
49+
# Codewars
50+
pytest codewars -q
51+
52+
# Edabit
53+
pytest edabit -q
54+
55+
# Python Workbook
56+
pytest learning/python-workbook -q
57+
```
58+
59+
---
60+
61+
### Repository Structure
62+
```bash
63+
python-challenges/
64+
├─ advent-of-code/ # Advent of Code solutions + tests
65+
├─ codewars/ # Codewars kata + tests
66+
├─ edabit/ # Edabit kata + tests
67+
├─ everybody_codes/ # Everybody Codes quests + tests
68+
└─ learning/
69+
└─ python-workbook/ # Python exercises
70+
```
71+
---

0 commit comments

Comments
 (0)