Skip to content

Commit d055671

Browse files
committed
docs: update installation instructions and prerequisites for Python 3.11
1 parent d9a9175 commit d055671

3 files changed

Lines changed: 13 additions & 53 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,36 +37,19 @@ This is a template repository for python module projects.
3737

3838
[TIP] Skip this step, if you're going to install the package directly from **PyPi** or **GitHub** repository.
3939

40-
**2.1.** Prepare projects directory (if not exists):
41-
4240
```sh
43-
# Create projects directory:
4441
mkdir -pv ~/workspaces/projects
45-
46-
# Enter into projects directory:
4742
cd ~/workspaces/projects
48-
```
49-
50-
**2.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
5143

52-
**OPTION A.** Clone the repository:
44+
# HTTPS:
45+
git clone https://github.com/bybatkhuu/module-python-template.git
46+
# Or SSH (development):
47+
git clone git@github.com:bybatkhuu/module-python-template.git
5348

54-
```sh
55-
git clone https://github.com/bybatkhuu/module-python-template.git && \
56-
cd module-python-template
49+
cd module-python-template
5750
```
5851

59-
**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
60-
61-
```sh
62-
git clone git@github.com:bybatkhuu/module-python-template.git && \
63-
cd module-python-template
64-
```
65-
66-
**OPTION C.** Download source code:
67-
68-
1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/module-python-template/releases).
69-
2. Extract it into the projects directory.
52+
Alternatively, download the source from the [releases](https://github.com/bybatkhuu/module-python-template/releases) page and extract it into your projects directory.
7053

7154
### 3. 📦 Install the package
7255

@@ -203,12 +186,6 @@ my_module01:
203186
204187
[**`.env.example`**](./.env.example):
205188

206-
```sh
207-
# ENV=LOCAL
208-
# DEBUG=false
209-
# TZ=UTC
210-
```
211-
212189
---
213190

214191
## 🧪 Running Tests

‎docs/getting-started/installation.md‎

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,19 @@ title: Installation
88

99
[TIP] Skip this step, if you're going to install the package directly from **PyPi** or **GitHub** repository.
1010

11-
**1.1.** Prepare projects directory (if not exists):
12-
1311
```sh
14-
# Create projects directory:
1512
mkdir -pv ~/workspaces/projects
16-
17-
# Enter into projects directory:
1813
cd ~/workspaces/projects
19-
```
20-
21-
**1.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
22-
23-
**OPTION A.** Clone the repository:
2414

25-
```sh
26-
git clone https://github.com/bybatkhuu/module-python-template.git && \
27-
cd module-python-template
28-
```
29-
30-
**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
15+
# HTTPS:
16+
git clone https://github.com/bybatkhuu/module-python-template.git
17+
# Or SSH (development):
18+
git clone git@github.com:bybatkhuu/module-python-template.git
3119

32-
```sh
33-
git clone git@github.com:bybatkhuu/module-python-template.git && \
34-
cd module-python-template
20+
cd module-python-template
3521
```
3622

37-
**OPTION C.** Download source code:
38-
39-
1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/module-python-template/releases).
40-
2. Extract it into the projects directory.
23+
Alternatively, download the source from the [releases](https://github.com/bybatkhuu/module-python-template/releases) page and extract it into your projects directory.
4124

4225
### 2. 📦 Install the package
4326

‎docs/getting-started/prerequisites.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Prerequisites
44

55
# 🚧 Prerequisites
66

7-
- Install **Python (>= v3.10)** and **pip (>= 23)**:
7+
- Install **Python (>= v3.11)** and **pip (>= 23)**:
88
- **[RECOMMENDED] [Miniconda (v3)](https://www.anaconda.com/docs/getting-started/miniconda/install)**
99
- *[arm64/aarch64] [Miniforge (v3)](https://github.com/conda-forge/miniforge)*
1010
- *[Python virtual environment] [venv](https://docs.python.org/3/library/venv.html)*

0 commit comments

Comments
 (0)